js.io

Class WildcardFilter

java.lang.Object

js.io.WildcardFilter

All Implemented Interfaces:

FileFilter, FilenameFilter, Serializable

public class WildcardFilter
extends Object
implements FileFilter, FilenameFilter, Serializable

Filters files using path pattern with wildcards. This filter selects files and directories based on path pattern. Pattern can contain one or more wildcard characters. Although this class implements file filter interfaces it can be used for generic string pattern matching, see accept(String).

The wildcard matcher uses the characters '?' and '*' to represent a single or multiple wildcard characters.

 File dir = new File(".");
 FileFilter fileFilter = new WildcardFileFilter("*test*.java");
 for (File file: dir.listFiles(fileFilter)) {
        ...
 }
 

Version:

final

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_ALL Path pattern accepting all files.
private String	pattern Pattern used to match file names and strings.
private static long	serialVersionUID Java serialization version.

Constructor Summary

Constructors

Constructor and Description
WildcardFilter(String pattern) Construct a new case-sensitive wildcard filter instance.

Method Summary

Modifier and Type	Method and Description
boolean	accept(File file) Test if name of the file matches this filter pattern.
boolean	accept(File dir, String name) Test if file name matches this filter pattern.
boolean	accept(String string) Returns true if string value matches this filter pattern.
private static boolean	match(String string, String pattern) Test if string value matches given pattern.
private static String[]	tokenize(String string) Splits a string into a number of tokens.
String	toString() Instance string representation.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Java serialization version.

See Also:

Constant Field Values

ACCEPT_ALL

public static final String ACCEPT_ALL

Path pattern accepting all files.

See Also:

Constant Field Values

pattern

private final String pattern

Pattern used to match file names and strings.

Constructor Detail

WildcardFilter

public WildcardFilter(String pattern)

Construct a new case-sensitive wildcard filter instance.

Parameters:

pattern - pattern used to match file names and strings.

Throws:

IllegalArgumentException - if the pattern is null or empty.

Method Detail

accept

public boolean accept(File dir,
                      String name)

Test if file name matches this filter pattern. This method has a directory parameter required by interface signature but is not used by current implementation.

If name argument is null or empty this predicate returns false.

Specified by:

accept in interface FilenameFilter

Parameters:

dir - unused file directory, for interface compatibility.

name - the file name, null or empty accepted.

Returns:

true if the name argument matches this filter pattern.

accept

public boolean accept(File file)

Test if name of the file matches this filter pattern. Returns false if file argument is null.

Specified by:

accept in interface FileFilter

Parameters:

file - the file to check, null accepted.

Returns:

true if name of the file matches this filter pattern.

accept

public boolean accept(String string)

Returns true if string value matches this filter pattern. Returns false if string argument is null or empty.

Parameters:

string - string value, null or empty accepted.

Returns:

true if string value matches this filter pattern.

toString

public String toString()

Instance string representation.

Overrides:

toString in class Object

match

private static boolean match(String string,
                             String pattern)

Test if string value matches given pattern. Returns false if string argument is null or empty. Pattern argument is guaranteed by this class logic to be not null and not empty.

Parameters:

string - string value to match against pattern, null or empty accepted,

pattern - not null or empty pattern.

Returns:

true if string value matches the pattern.

tokenize

private static String[] tokenize(String string)

Splits a string into a number of tokens.

Parameters:

string - string to split.

Returns:

tokens list.