DirectoryWalker.CancelException

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.io.IOException
    - - org.apache.commons.io.DirectoryWalker.CancelException

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

DirectoryWalker<T>
```
public static class DirectoryWalker.CancelException
extends java.io.IOException
```
CancelException is thrown in DirectoryWalker to cancel the current processing.

See Also:

Serialized Form

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getDepth()`	Returns the depth when the operation was canceled.
`java.io.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

- Constructor Detail
  - CancelException
```
public CancelException(java.io.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(java.lang.String message,
                       java.io.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 Detail
  - getDepth
```
public int getDepth()
```
    Returns the depth when the operation was canceled.
    
    Returns:
    
    the depth when the operation was canceled.
  - getFile
```
public java.io.File getFile()
```
    Returns the file when the operation was canceled.
    
    Returns:
    
    the file when the operation was canceled.