Package 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 matched against base filename.

Since:

2.1

Constructor Summary

Constructors

Constructor	Description
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.
PatternFileSelector(Pattern pattern)	Creates a new selector for the given pattern.

Method Summary

Modifier and Type	Method	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 Details

PatternFileSelector

public PatternFileSelector(Pattern pattern)

Creates a new selector for the given pattern.

Parameters:

pattern - The regular expressed used by this selector.

PatternFileSelector

public PatternFileSelector(String regex)

Creates a new selector for the given pattern.

Parameters:

regex - The regular expressed used by this selector.

PatternFileSelector

public PatternFileSelector(String regex,
 int flags)

Creates a new selector for the given Pattern and flags.

Parameters:

regex - The expression to be compiled

flags - Match flags, a bit mask.

See Also:

• Pattern.compile(String, int)

Method Details

includeFile

public boolean includeFile(FileSelectInfo fileInfo)

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.

toString

public String toString()

Overrides:

toString in class Object

traverseDescendents

public boolean traverseDescendents(FileSelectInfo fileInfo)

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, false otherwise.