commons-io 1.3.2 · org.apache.commons.io.filefilter.WildcardFileFilter

Filters files using the supplied wildcards.

This filter selects files and directories based on one or more wildcards. Testing is case-sensitive by default, but this can be configured.

The wildcard matcher uses the characters '?' and '*' to represent a single or multiple wildcard characters. This is the same as often found on Dos/Unix command lines. The extension check is case-sensitive by . See FilenameUtils#wildcardMatchOnSystem for more information.

For example:

File dir = new File(".");
FileFilter fileFilter = new WildcardFileFilter("*test*.java~*~");
File[] files = dir.listFiles(fileFilter);
for (int i = 0; i < files.length; i++) {
  System.out.println(files[i]);
}

Modifier and Type	Field and Description
private IOCase	caseSensitivity Whether the comparison is case sensitive.
private String[]	wildcards The wildcards that will be used to match filenames.

Constructor Summary

Access	Constructor and Description
public	WildcardFileFilter(String the wildcard to match wildcard) Construct a new case-sensitive wildcard filter for a single wildcard.
public	WildcardFileFilter(String the wildcard to match, not null wildcard, IOCase how to handle case sensitivity, null means case-sensitive caseSensitivity) Construct a new wildcard filter for a single wildcard specifying case-sensitivity.
public	WildcardFileFilter(String[] the array of wildcards to match wildcards) Construct a new case-sensitive wildcard filter for an array of wildcards.
public	WildcardFileFilter(String[] the array of wildcards to match, not null wildcards, IOCase how to handle case sensitivity, null means case-sensitive caseSensitivity) Construct a new wildcard filter for an array of wildcards specifying case-sensitivity.
public	WildcardFileFilter(List<E> the list of wildcards to match, not null wildcards) Construct a new case-sensitive wildcard filter for a list of wildcards.
public	WildcardFileFilter(List<E> the list of wildcards to match, not null wildcards, IOCase how to handle case sensitivity, null means case-sensitive caseSensitivity) Construct a new wildcard filter for a list of wildcards specifying case-sensitivity.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the filename matches one of the wildcards accept(File the file directory dir, String the filename name) Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept. Implements org.apache.commons.io.filefilter.IOFileFilter.accept. Checks to see if the filename matches one of the wildcards.
public boolean	Returns: true if the filename matches one of the wildcards accept(File the file to check file) Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept. Implements org.apache.commons.io.filefilter.IOFileFilter.accept. Checks to see if the filename matches one of the wildcards.

Field Detail

caseSensitivity	back to summary
private IOCase caseSensitivity Whether the comparison is case sensitive.

wildcards	back to summary
private String[] wildcards The wildcards that will be used to match filenames.

Constructor Detail

WildcardFileFilter	back to summary
public WildcardFileFilter(String wildcard) Construct a new case-sensitive wildcard filter for a single wildcard. Parameters wildcard:String the wildcard to match Exceptions IllegalArgumentException: if the pattern is null

WildcardFileFilter

back to summary

public WildcardFileFilter(String wildcard)

Construct a new case-sensitive wildcard filter for a single wildcard.

Parameters

wildcard:String: the wildcard to match

Exceptions

IllegalArgumentException:: if the pattern is null

WildcardFileFilter	back to summary
public WildcardFileFilter(String wildcard, IOCase caseSensitivity) Construct a new wildcard filter for a single wildcard specifying case-sensitivity. Parameters wildcard:String the wildcard to match, not null caseSensitivity:IOCase how to handle case sensitivity, null means case-sensitive Exceptions IllegalArgumentException: if the pattern is null

WildcardFileFilter

back to summary

public WildcardFileFilter(String wildcard, IOCase caseSensitivity)

Construct a new wildcard filter for a single wildcard specifying case-sensitivity.

Parameters

wildcard:String: the wildcard to match, not null
caseSensitivity:IOCase: how to handle case sensitivity, null means case-sensitive

Exceptions

IllegalArgumentException:: if the pattern is null

WildcardFileFilter	back to summary
public WildcardFileFilter(String[] wildcards) Construct a new case-sensitive wildcard filter for an array of wildcards. The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however. Parameters wildcards:String[] the array of wildcards to match Exceptions IllegalArgumentException: if the pattern array is null

WildcardFileFilter

back to summary

public WildcardFileFilter(String[] wildcards)

Construct a new case-sensitive wildcard filter for an array of wildcards.

The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.

Parameters

wildcards:String[]: the array of wildcards to match

Exceptions

IllegalArgumentException:: if the pattern array is null

WildcardFileFilter	back to summary
public WildcardFileFilter(String[] wildcards, IOCase caseSensitivity) Construct a new wildcard filter for an array of wildcards specifying case-sensitivity. The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however. Parameters wildcards:String[] the array of wildcards to match, not null caseSensitivity:IOCase how to handle case sensitivity, null means case-sensitive Exceptions IllegalArgumentException: if the pattern array is null

WildcardFileFilter

back to summary

public WildcardFileFilter(String[] wildcards, IOCase caseSensitivity)

Construct a new wildcard filter for an array of wildcards specifying case-sensitivity.

The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.

Parameters

wildcards:String[]: the array of wildcards to match, not null
caseSensitivity:IOCase: how to handle case sensitivity, null means case-sensitive

Exceptions

IllegalArgumentException:: if the pattern array is null

WildcardFileFilter	back to summary
public WildcardFileFilter(List<E> wildcards) Construct a new case-sensitive wildcard filter for a list of wildcards. Parameters wildcards:List<E> the list of wildcards to match, not null Exceptions IllegalArgumentException: if the pattern list is null ClassCastException: if the list does not contain Strings

WildcardFileFilter

back to summary

public WildcardFileFilter(List<E> wildcards)

Construct a new case-sensitive wildcard filter for a list of wildcards.

Parameters

wildcards:List<E>: the list of wildcards to match, not null

Exceptions

IllegalArgumentException:: if the pattern list is null
ClassCastException:: if the list does not contain Strings

WildcardFileFilter	back to summary
public WildcardFileFilter(List<E> wildcards, IOCase caseSensitivity) Construct a new wildcard filter for a list of wildcards specifying case-sensitivity. Parameters wildcards:List<E> the list of wildcards to match, not null caseSensitivity:IOCase how to handle case sensitivity, null means case-sensitive Exceptions IllegalArgumentException: if the pattern list is null ClassCastException: if the list does not contain Strings

WildcardFileFilter

back to summary

public WildcardFileFilter(List<E> wildcards, IOCase caseSensitivity)

Construct a new wildcard filter for a list of wildcards specifying case-sensitivity.

Parameters

wildcards:List<E>: the list of wildcards to match, not null
caseSensitivity:IOCase: how to handle case sensitivity, null means case-sensitive

Exceptions

IllegalArgumentException:: if the pattern list is null
ClassCastException:: if the list does not contain Strings

Method Detail

accept	back to summary
public boolean accept(File dir, String name) Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept. Implements org.apache.commons.io.filefilter.IOFileFilter.accept. Checks to see if the filename matches one of the wildcards. Parameters dir:File the file directory name:String the filename Returns:boolean true if the filename matches one of the wildcards

back to summary

public boolean accept(File dir, String name)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename matches one of the wildcards.

Parameters

dir:File: the file directory
name:String: the filename

Returns:boolean

true if the filename matches one of the wildcards

accept	back to summary
public boolean accept(File file) Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept. Implements org.apache.commons.io.filefilter.IOFileFilter.accept. Checks to see if the filename matches one of the wildcards. Parameters file:File the file to check Returns:boolean true if the filename matches one of the wildcards

back to summary

public boolean accept(File file)

Overrides org.apache.commons.io.filefilter.AbstractFileFilter.accept.

Implements org.apache.commons.io.filefilter.IOFileFilter.accept.

Checks to see if the filename matches one of the wildcards.

Parameters

file:File: the file to check

Returns:boolean

true if the filename matches one of the wildcards

public Class WildcardFileFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail