org.apache.commons.vfs2

Class PatternFileSelector

java.lang.Object

org.apache.commons.vfs2.PatternFileSelector

All Implemented Interfaces:

FileSelector

public class PatternFileSelector
extends Object
implements FileSelector

A FileSelector that selects based on regular expressions.

The regular expression specified in one of the constructors is matched against FileName.getPath() of all candidate files. If you want to match only against the base file name, make sure to prefix the pattern with ".\*\/".

Since:

2.1

Constructor Summary

Constructors

Constructor and Description
PatternFileSelector(Pattern pattern) Creates a new selector for the given pattern.
PatternFileSelector(String regex) Creates a new selector for the given pattern.
PatternFileSelector(String regex, int flags) Creates a new selector for the given Pattern and flags.

Method Summary

Modifier and Type	Method and Description
boolean	includeFile(FileSelectInfo fileInfo) Determines if a file or folder should be selected.
String	toString()
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, wait, wait, wait

Constructor Detail

PatternFileSelector

public PatternFileSelector(Pattern pattern)

Creates a new selector for the given pattern.

See PatternFileSelector for a specification how the pattern is matched.

Parameters:

pattern - The regular expressed used by this selector.

PatternFileSelector

public PatternFileSelector(String regex)

Creates a new selector for the given pattern.

See PatternFileSelector for a specification how the pattern is matched.

Parameters:

regex - The regular expressed used by this selector.

See Also:

Pattern.compile(String, int)

PatternFileSelector

public PatternFileSelector(String regex,
                           int flags)

Creates a new selector for the given Pattern and flags.

See PatternFileSelector for a specification how the pattern is matched.

Parameters:

regex - The expression to be compiled

flags - Match flags, a bit mask.

See Also:

Pattern.compile(String, int)

Method Detail

includeFile

public boolean includeFile(FileSelectInfo fileInfo)
                    throws Exception

Determines if a file or folder should be selected.

See PatternFileSelector for a specification how the pattern is matched.

Specified by:

includeFile in interface FileSelector

Parameters:

fileInfo - The file selection information.

Returns:

true if the file should be selected, false otherwise.

Throws:

Exception - if an error occurs.

toString

public String toString()

Overrides:

toString in class Object

traverseDescendents

public boolean traverseDescendents(FileSelectInfo fileInfo)
                            throws Exception

Determines whether a folder should be traversed.

This implementation always returns true to make sure all leafs are inspected.

Specified by:

traverseDescendents in interface FileSelector

Parameters:

fileInfo - The file selection information.

Returns:

true if descendants should be traversed, false otherwise.

Throws:

Exception - if an error occurs.