org.apache.commons.io

Class DirectoryWalker.CancelException

public static class DirectoryWalker.CancelException extends IOException

CancelException is thrown in DirectoryWalker to cancel the current processing.
Field Summary
intdepth
The file depth when the exception was thrown.
Filefile
The file being processed when the exception was thrown.
static longserialVersionUID
Serialization id.
Constructor Summary
CancelException(File file, int depth)
Constructs a CancelException with the file and depth when cancellation occurred.
CancelException(String message, File file, int depth)
Constructs a CancelException with an appropriate message and the file and depth when cancellation occurred.
Method Summary
intgetDepth()
Return the depth when the operation was cancelled.
FilegetFile()
Return the file when the operation was cancelled.

Field Detail

depth

private int depth
The file depth when the exception was thrown.

file

private File file
The file being processed when the exception was thrown.

serialVersionUID

private static final long serialVersionUID
Serialization id.

Constructor Detail

CancelException

public CancelException(File file, int depth)
Constructs a CancelException with the file and depth when cancellation occurred.

Parameters: file the file when the operation was cancelled, may be null depth the depth when the operation was cancelled, may be null

CancelException

public CancelException(String message, File file, int depth)
Constructs a 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 cancelled depth the depth when the operation was cancelled

Method Detail

getDepth

public int getDepth()
Return the depth when the operation was cancelled.

Returns: the depth when the operation was cancelled

getFile

public File getFile()
Return the file when the operation was cancelled.

Returns: the file when the operation was cancelled

Copyright (c) 2002-2011 Apache Software Foundation