org.apache.commons.vfs2

Class FileDepthSelector

java.lang.Object

org.apache.commons.vfs2.FileDepthSelector

All Implemented Interfaces:

FileSelector

Direct Known Subclasses:

FileFilterSelector

public class FileDepthSelector
extends Object
implements FileSelector

A FileSelector that selects all files in a particular depth range.

Constructor Summary

Constructors

Constructor and Description
FileDepthSelector() Creates a selector with the same minimum and maximum depths of 0.
FileDepthSelector(int minMaxDepth) Creates a selector with the same minimum and maximum depths.
FileDepthSelector(int minDepth, int maxDepth) Creates a selector with the given minimum and maximum depths.

Method Summary

Modifier and Type	Method and Description
boolean	includeFile(FileSelectInfo fileInfo) Determines if a file or folder should be selected.
boolean	traverseDescendents(FileSelectInfo fileInfo) Determines whether a folder should be traversed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.vfs2.FileSelector

traverseDescendants

Constructor Detail

FileDepthSelector

public FileDepthSelector()

Creates a selector with the same minimum and maximum depths of 0.

Since:

2.1

FileDepthSelector

public FileDepthSelector(int minMaxDepth)

Creates a selector with the same minimum and maximum depths.

Parameters:

minMaxDepth - minimum and maximum depth

Since:

2.1

FileDepthSelector

public FileDepthSelector(int minDepth,
                         int maxDepth)

Creates a selector with the given minimum and maximum depths.

Parameters:

minDepth - minimum depth

maxDepth - maximum depth

Method Detail

includeFile

public boolean includeFile(FileSelectInfo fileInfo)
                    throws Exception

Determines if a file or folder should be selected.

Specified by:

includeFile in interface FileSelector

Parameters:

fileInfo - The file selection information

Returns:

true if the file or folder should be included, false otherwise.

Throws:

Exception - if an error occurs.

traverseDescendents

public boolean traverseDescendents(FileSelectInfo fileInfo)
                            throws Exception

Determines whether a folder should be traversed.

Specified by:

traverseDescendents in interface FileSelector

Parameters:

fileInfo - The file selection information

Returns:

true if the file or folder should be traversed, false otherwise.

Throws:

Exception - if an error occurs.