org.apache.commons.io

Class DirectoryWalker.CancelException

Enclosing Class:
DirectoryWalker

public static class DirectoryWalker.CancelException
extends IOException

CancelException is thrown in DirectoryWalker to cancel the current processing.

Field Summary

private int
depth
The file depth when the exception was thrown.
private File
file
The file being processed when the exception was thrown.
private static long
serialVersionUID
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

int
getDepth()
Return the depth when the operation was cancelled.
File
getFile()
Return the file when the operation was cancelled.

Field Details

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.
Field Value:
1347339620135041008L

Constructor Details

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 Details

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-2009 Apache Software Foundation