|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.io.filefilter.AbstractFileFilter org.apache.commons.io.filefilter.WildcardFileFilter
public class 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(java.lang.String, java.lang.String)
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]); }
Constructor Summary | |
---|---|
WildcardFileFilter(List<String> wildcards)
Construct a new case-sensitive wildcard filter for a list of wildcards. |
|
WildcardFileFilter(List<String> wildcards,
IOCase caseSensitivity)
Construct a new wildcard filter for a list of wildcards specifying case-sensitivity. |
|
WildcardFileFilter(String wildcard)
Construct a new case-sensitive wildcard filter for a single wildcard. |
|
WildcardFileFilter(String[] wildcards)
Construct a new case-sensitive wildcard filter for an array of wildcards. |
|
WildcardFileFilter(String[] wildcards,
IOCase caseSensitivity)
Construct a new wildcard filter for an array of wildcards specifying case-sensitivity. |
|
WildcardFileFilter(String wildcard,
IOCase caseSensitivity)
Construct a new wildcard filter for a single wildcard specifying case-sensitivity. |
Method Summary | |
---|---|
boolean |
accept(File file)
Checks to see if the filename matches one of the wildcards. |
boolean |
accept(File dir,
String name)
Checks to see if the filename matches one of the wildcards. |
String |
toString()
Provide a String representaion of this file filter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public WildcardFileFilter(String wildcard)
wildcard
- the wildcard to match
IllegalArgumentException
- if the pattern is nullpublic WildcardFileFilter(String wildcard, IOCase caseSensitivity)
wildcard
- the wildcard to match, not nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive
IllegalArgumentException
- if the pattern is nullpublic WildcardFileFilter(String[] wildcards)
The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.
wildcards
- the array of wildcards to match
IllegalArgumentException
- if the pattern array is nullpublic WildcardFileFilter(String[] wildcards, IOCase caseSensitivity)
The array is not cloned, so could be changed after constructing the instance. This would be inadvisable however.
wildcards
- the array of wildcards to match, not nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive
IllegalArgumentException
- if the pattern array is nullpublic WildcardFileFilter(List<String> wildcards)
wildcards
- the list of wildcards to match, not null
IllegalArgumentException
- if the pattern list is null
ClassCastException
- if the list does not contain Stringspublic WildcardFileFilter(List<String> wildcards, IOCase caseSensitivity)
wildcards
- the list of wildcards to match, not nullcaseSensitivity
- how to handle case sensitivity, null means case-sensitive
IllegalArgumentException
- if the pattern list is null
ClassCastException
- if the list does not contain StringsMethod Detail |
---|
public boolean accept(File dir, String name)
accept
in interface FilenameFilter
accept
in interface IOFileFilter
accept
in class AbstractFileFilter
dir
- the file directory (ignored)name
- the filename
public boolean accept(File file)
accept
in interface FileFilter
accept
in interface IOFileFilter
accept
in class AbstractFileFilter
file
- the file to check
public String toString()
toString
in class AbstractFileFilter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |