public class WildcardFileFilter extends AbstractFileFilter implements Serializable
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.
For example:
File dir = FileUtils.current(); FileFilter fileFilter = new WildcardFileFilter("*test*.java~*~"); File[] files = dir.listFiles(fileFilter); for (String file : files) { System.out.println(file); }
final Path dir = PathUtils.current(); final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(new WildcardFileFilter("*test*.java~*~")); // // Walk one dir Files.walkFileTree(dir, Collections.emptySet(), 1, visitor); System.out.println(visitor.getPathCounters()); System.out.println(visitor.getFileList()); // visitor.getPathCounters().reset(); // // Walk dir tree Files.walkFileTree(dir, visitor); System.out.println(visitor.getPathCounters()); System.out.println(visitor.getDirList()); System.out.println(visitor.getFileList());
Serialization is deprecated and will be removed in 3.0.
Modifier and Type | Class and Description |
---|---|
static class |
WildcardFileFilter.Builder
Builds a new
WildcardFileFilter instance. |
EMPTY_STRING_ARRAY
Constructor and Description |
---|
WildcardFileFilter(List<String> wildcards)
Deprecated.
Use
builder() |
WildcardFileFilter(List<String> wildcards,
IOCase ioCase)
Deprecated.
Use
builder() |
WildcardFileFilter(String... wildcards)
Deprecated.
Use
builder() |
WildcardFileFilter(String wildcard)
Deprecated.
Use
builder() |
WildcardFileFilter(String[] wildcards,
IOCase ioCase)
Deprecated.
Use
builder() |
WildcardFileFilter(String wildcard,
IOCase ioCase)
Deprecated.
Use
builder() |
Modifier and Type | Method and Description |
---|---|
boolean |
accept(File file)
Checks to see if the file name matches one of the wildcards.
|
boolean |
accept(File dir,
String name)
Checks to see if the file name matches one of the wildcards.
|
FileVisitResult |
accept(Path file,
BasicFileAttributes attributes)
Checks to see if the file name matches one of the wildcards.
|
static WildcardFileFilter.Builder |
builder()
Constructs a new
WildcardFileFilter.Builder . |
String |
toString()
Provide a String representation of this file filter.
|
handle, postVisitDirectory, preVisitDirectory, visitFile, visitFileFailed
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
and, negate, or
@Deprecated public WildcardFileFilter(List<String> wildcards)
builder()
wildcards
- the list of wildcards to match, not nullIllegalArgumentException
- if the pattern list is nullClassCastException
- if the list does not contain Strings@Deprecated public WildcardFileFilter(List<String> wildcards, IOCase ioCase)
builder()
wildcards
- the list of wildcards to match, not nullioCase
- how to handle case sensitivity, null means case-sensitiveIllegalArgumentException
- if the pattern list is nullClassCastException
- if the list does not contain Strings@Deprecated public WildcardFileFilter(String wildcard)
builder()
wildcard
- the wildcard to matchIllegalArgumentException
- if the pattern is null@Deprecated public WildcardFileFilter(String... wildcards)
builder()
wildcards
- the array of wildcards to matchNullPointerException
- if the pattern array is null@Deprecated public WildcardFileFilter(String wildcard, IOCase ioCase)
builder()
wildcard
- the wildcard to match, not nullioCase
- how to handle case sensitivity, null means case-sensitiveNullPointerException
- if the pattern is null@Deprecated public WildcardFileFilter(String[] wildcards, IOCase ioCase)
builder()
wildcards
- the array of wildcards to match, not nullioCase
- how to handle case sensitivity, null means case-sensitiveNullPointerException
- if the pattern array is nullpublic static WildcardFileFilter.Builder builder()
WildcardFileFilter.Builder
.WildcardFileFilter.Builder
.public boolean accept(File file)
accept
in interface FileFilter
accept
in interface IOFileFilter
accept
in class AbstractFileFilter
file
- the file to checkpublic 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 file namepublic FileVisitResult accept(Path file, BasicFileAttributes attributes)
accept
in interface PathFilter
accept
in interface IOFileFilter
file
- the file to checkattributes
- the file's basic attributes (TODO may be null).public String toString()
toString
in class AbstractFileFilter
Copyright © 2002–2023 The Apache Software Foundation. All rights reserved.