org.apache.commons.vfs2
Interface FileSelectInfo


public interface FileSelectInfo

Information about a file, that is used to select files during the traversal of a hierarchy.

Author:
Commons VFS team
To Do:
Rename this interface, as it is used by both FileSelector and FileVisitor.

Method Summary
 FileObject getBaseFolder()
          Returns the base folder of the traversal.
 int getDepth()
          Returns the depth of the file relative to the base folder.
 FileObject getFile()
          Returns the file (or folder) to be considered.
 

Method Detail

getBaseFolder

FileObject getBaseFolder()
Returns the base folder of the traversal.

Returns:
FileObject representing the base folder.

getFile

FileObject getFile()
Returns the file (or folder) to be considered.

Returns:
The FileObject.

getDepth

int getDepth()
Returns the depth of the file relative to the base folder.

Returns:
The depth of the file relative to the base folder.


Copyright © 2002-2012 The Apache Software Foundation. All Rights Reserved.