Package org.apache.commons.io.filefilter
Class WildcardFileFilter
java.lang.Object
org.apache.commons.io.filefilter.AbstractFileFilter
org.apache.commons.io.filefilter.WildcardFileFilter
- All Implemented Interfaces:
- FileFilter,- FilenameFilter,- Serializable,- FileVisitor<Path>,- PathMatcher,- PathFilter,- PathVisitor,- IOFileFilter
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 check is case-sensitive by default. See FilenameUtils.wildcardMatchOnSystem(String,String) for more information.
 
 To build an instance, use WildcardFileFilter.Builder.
 
For example:
Using Classic IO
 File dir = FileUtils.current();
 FileFilter fileFilter = WildcardFileFilter.builder().setWildcards("*test*.java~*~").get();
 File[] files = dir.listFiles(fileFilter);
 for (String file : files) {
     System.out.println(file);
 }
 
 Using NIO
 final Path dir = PathUtils.current();
 final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(
     WildcardFileFilter.builder().setWildcards("*test*.java~*~").get());
 //
 // Walk one directory
 Files.walkFileTree(dir, Collections.emptySet(), 1, visitor);
 System.out.println(visitor.getPathCounters());
 System.out.println(visitor.getFileList());
 //
 visitor.getPathCounters().reset();
 //
 // Walk directory tree
 Files.walkFileTree(dir, visitor);
 System.out.println(visitor.getPathCounters());
 System.out.println(visitor.getDirList());
 System.out.println(visitor.getFileList());
 
 Deprecating Serialization
Serialization is deprecated and will be removed in 3.0.
- Since:
- 1.3
- See Also:
- 
Nested Class SummaryNested Classes
- 
Field SummaryFields inherited from interface org.apache.commons.io.filefilter.IOFileFilterEMPTY_STRING_ARRAY
- 
Constructor SummaryConstructorsConstructorDescriptionWildcardFileFilter(String wildcard) Deprecated.WildcardFileFilter(String... wildcards) Deprecated.WildcardFileFilter(String[] wildcards, IOCase ioCase) Deprecated.WildcardFileFilter(String wildcard, IOCase ioCase) Deprecated.WildcardFileFilter(List<String> wildcards) Deprecated.WildcardFileFilter(List<String> wildcards, IOCase ioCase) Deprecated.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanTests to see if the file name matches one of the wildcards.booleanTests to see if the file name matches one of the wildcards.accept(Path path, BasicFileAttributes attributes) Tests to see if the file name matches one of the wildcards.static WildcardFileFilter.Builderbuilder()Constructs a newWildcardFileFilter.Builder.toString()Provide a String representation of this file filter.Methods inherited from class org.apache.commons.io.filefilter.AbstractFileFilterhandle, postVisitDirectory, preVisitDirectory, visitFile, visitFileFailedMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.io.filefilter.IOFileFilterand, matches, negate, or
- 
Constructor Details- 
WildcardFileFilterDeprecated.Constructs a new case-sensitive wildcard filter for a list of wildcards.- Parameters:
- wildcards- the list of wildcards to match, not null
- Throws:
- IllegalArgumentException- if the pattern list is null
- ClassCastException- if the list does not contain Strings
 
- 
WildcardFileFilterDeprecated.Constructs a new wildcard filter for a list of wildcards specifying case-sensitivity.- Parameters:
- wildcards- the list of wildcards to match, not null
- ioCase- how to handle case sensitivity, null means case-sensitive
- Throws:
- IllegalArgumentException- if the pattern list is null
- ClassCastException- if the list does not contain Strings
 
- 
WildcardFileFilterDeprecated.Constructs a new case-sensitive wildcard filter for a single wildcard.- Parameters:
- wildcard- the wildcard to match
- Throws:
- IllegalArgumentException- if the pattern is null
 
- 
WildcardFileFilterDeprecated.Constructs a new case-sensitive wildcard filter for an array of wildcards.- Parameters:
- wildcards- the array of wildcards to match
- Throws:
- NullPointerException- if the pattern array is null
 
- 
WildcardFileFilterDeprecated.Constructs a new wildcard filter for a single wildcard specifying case-sensitivity.- Parameters:
- wildcard- the wildcard to match, not null
- ioCase- how to handle case sensitivity, null means case-sensitive
- Throws:
- NullPointerException- if the pattern is null
 
- 
WildcardFileFilterDeprecated.Constructs a new wildcard filter for an array of wildcards specifying case-sensitivity.- Parameters:
- wildcards- the array of wildcards to match, not null
- ioCase- how to handle case sensitivity, null means case-sensitive
- Throws:
- NullPointerException- if the pattern array is null
 
 
- 
- 
Method Details- 
builderConstructs a newWildcardFileFilter.Builder.- Returns:
- a new WildcardFileFilter.Builder.
- Since:
- 2.12.0
 
- 
acceptTests to see if the file name matches one of the wildcards.- Specified by:
- acceptin interface- FileFilter
- Specified by:
- acceptin interface- IOFileFilter
- Overrides:
- acceptin class- AbstractFileFilter
- Parameters:
- file- the file to check
- Returns:
- true if the file name matches one of the wildcards
 
- 
acceptTests to see if the file name matches one of the wildcards.- Specified by:
- acceptin interface- FilenameFilter
- Specified by:
- acceptin interface- IOFileFilter
- Overrides:
- acceptin class- AbstractFileFilter
- Parameters:
- dir- the file directory (ignored)
- name- the file name
- Returns:
- true if the file name matches one of the wildcards
 
- 
acceptTests to see if the file name matches one of the wildcards.- Specified by:
- acceptin interface- IOFileFilter
- Specified by:
- acceptin interface- PathFilter
- Parameters:
- path- the file to check
- attributes- the path's basic attributes (may be null).
- Returns:
- true if the file name matches one of the wildcards.
- Since:
- 2.9.0
 
- 
toStringProvide a String representation of this file filter.- Overrides:
- toStringin class- AbstractFileFilter
- Returns:
- a String representation
 
 
- 
builder(),WildcardFileFilter.Builder, andWildcardFileFilter.Builder.get()