org.apache.commons.vfs2

Class FileExtensionSelector

java.lang.Object

org.apache.commons.vfs2.FileExtensionSelector

All Implemented Interfaces:

FileSelector

public class FileExtensionSelector
extends java.lang.Object
implements FileSelector

A FileSelector that selects based on file extensions.

The extension comparison is case insensitive.

The selector makes a copy of a given Collection or array. Changing the object passed in the constructors will not affect the selector.

Since:

2.1

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<java.lang.String>	extensions The extensions to select.

Constructor Summary

Constructors

Constructor and Description
FileExtensionSelector(java.util.Collection<java.lang.String> extensions) Creates a new selector for the given extensions.
FileExtensionSelector(java.lang.String... extensions) Creates a new selector for the given extensions.

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

Field Detail

extensions

private final java.util.Set<java.lang.String> extensions

The extensions to select.

Constructor Detail

FileExtensionSelector

public FileExtensionSelector(java.util.Collection<java.lang.String> extensions)

Creates a new selector for the given extensions.

Parameters:

extensions - The extensions to be included by this selector.

FileExtensionSelector

public FileExtensionSelector(java.lang.String... extensions)

Creates a new selector for the given extensions.

Parameters:

extensions - The extensions to be included by this selector.

Method Detail

includeFile

public boolean includeFile(FileSelectInfo fileInfo)
                    throws java.lang.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 should be selected, false otherwise.

Throws:

java.lang.Exception - if an error occurs.

traverseDescendents

public boolean traverseDescendents(FileSelectInfo fileInfo)
                            throws java.lang.Exception

Determines whether a folder should be traversed.

Specified by:

traverseDescendents in interface FileSelector

Parameters:

fileInfo - The file selection information.

Returns:

true if descendants should be traversed, fase otherwise.

Throws:

java.lang.Exception - if an error occurs.