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:
  • 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 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 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 cancelled
      depth - the depth when the operation was cancelled
  • Method Details

    • getDepth

      public int getDepth()
      Returns the depth when the operation was cancelled.
      Returns:
      the depth when the operation was cancelled
    • getFile

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