Package org.apache.commons.io.filefilter
Class SymbolicLinkFileFilter
java.lang.Object
org.apache.commons.io.filefilter.AbstractFileFilter
org.apache.commons.io.filefilter.SymbolicLinkFileFilter
- All Implemented Interfaces:
- FileFilter,- FilenameFilter,- Serializable,- FileVisitor<Path>,- PathMatcher,- PathFilter,- PathVisitor,- IOFileFilter
This filter accepts 
Files that are symbolic links.
 For example, here is how to print out a list of the real files within the current directory:
Using Classic IO
 File dir = FileUtils.current();
 String[] files = dir.list(SymbolicLinkFileFilter.INSTANCE);
 for (String file : files) {
     System.out.println(file);
 }
 
 Using NIO
final Path dir = PathUtils.current(); final AccumulatorPathVisitor visitor = AccumulatorPathVisitor.withLongCounters(SymbolicLinkFileFilter.INSTANCE); // // 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:
- 2.11.0
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final SymbolicLinkFileFilterSingleton instance of file filter.Fields inherited from interface org.apache.commons.io.filefilter.IOFileFilterEMPTY_STRING_ARRAY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedRestrictive constructor.SymbolicLinkFileFilter(FileVisitResult onAccept, FileVisitResult onReject) Constructs a new instance.
- 
Method SummaryModifier and TypeMethodDescriptionbooleanTests to see if the file is a symbolic link.accept(Path path, BasicFileAttributes attributes) Tests to see if the file is a symbolic link.Methods inherited from class org.apache.commons.io.filefilter.AbstractFileFilteraccept, handle, postVisitDirectory, preVisitDirectory, toString, 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
- 
Field Details- 
INSTANCESingleton instance of file filter.
 
- 
- 
Constructor Details- 
SymbolicLinkFileFilterprotected SymbolicLinkFileFilter()Restrictive constructor.
- 
SymbolicLinkFileFilterConstructs a new instance.- Parameters:
- onAccept- What to do on acceptance.
- onReject- What to do on rejection.
- Since:
- 2.12.0.
 
 
- 
- 
Method Details- 
acceptTests to see if the file is a symbolic link.- 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 exists and is a symbolic link to either another file or a directory, false otherwise.
 
- 
acceptTests to see if the file is a symbolic link.- Specified by:
- acceptin interface- IOFileFilter
- Specified by:
- acceptin interface- PathFilter
- Parameters:
- path- the File Path to check
- attributes- the path's basic attributes (may be null).
- Returns:
- onAcceptfrom- SymbolicLinkFileFilter(FileVisitResult, FileVisitResult)if the file exists and is a symbolic link to either another file or a directory; returns- onRejectotherwise.
 
 
-