Package org.apache.commons.io

Class DirectoryWalker.CancelException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.apache.commons.io.DirectoryWalker.CancelException

All Implemented Interfaces:

Serializable

Enclosing class:

DirectoryWalker<T>

public static class DirectoryWalker.CancelException
extends IOException

CancelException is thrown in DirectoryWalker to cancel the current processing.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final int	depth	The file depth when the exception was thrown.
private final File	file	The file being processed when the exception was thrown.
private static final long	serialVersionUID	Serialization id.

Constructor Summary

Constructors

Constructor	Description
CancelException(File file, int depth)	Constructs a DirectoryWalker.CancelException with the file and depth when cancellation occurred.
CancelException(String message, File file, int depth)	Constructs a DirectoryWalker.CancelException with an appropriate message and the file and depth when cancellation occurred.

Method Summary

Modifier and Type	Method	Description
int	getDepth()	Returns the depth when the operation was canceled.
File	getFile()	Returns the file when the operation was canceled.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

Serialization id.

See Also:

• Constant Field Values

file

private final File file

The file being processed when the exception was thrown.

depth

private final int depth

The file depth when the exception was thrown.

Constructor Details

CancelException

public CancelException(File file,
 int depth)

Constructs a DirectoryWalker.CancelException with the file and depth when cancellation occurred.

Parameters:

file - the file when the operation was canceled, may be null.

depth - the depth when the operation was canceled, may be null.

CancelException

public CancelException(String message,
 File file,
 int depth)

Constructs a DirectoryWalker.CancelException with an appropriate message and the file and depth when cancellation occurred.

Parameters:

message - the detail message.

file - the file when the operation was canceled.

depth - the depth when the operation was canceled.

Method Details

getDepth

public int getDepth()

Returns the depth when the operation was canceled.

Returns:

the depth when the operation was canceled.

getFile

public File getFile()

Returns the file when the operation was canceled.

Returns:

the file when the operation was canceled.