org.apache.commons.io.filefilter

Class CanReadFileFilter

java.lang.Object

org.apache.commons.io.filefilter.AbstractFileFilter

org.apache.commons.io.filefilter.CanReadFileFilter

All Implemented Interfaces:

java.io.FileFilter, java.io.FilenameFilter, java.io.Serializable, java.nio.file.FileVisitor<java.nio.file.Path>, PathFilter, PathVisitor, IOFileFilter

public class CanReadFileFilter
extends AbstractFileFilter
implements java.io.Serializable

This filter accepts Files that can be read.

Example, showing how to print out a list of the current directory's readable files:

Using Classic IO

 File dir = FileUtils.current();
 String[] files = dir.list(CanReadFileFilter.CAN_READ);
 for (String file : files) {
     System.out.println(file);
 }
 

Example, showing how to print out a list of the current directory's un-readable files:

 File dir = FileUtils.current();
 String[] files = dir.list(CanReadFileFilter.CANNOT_READ);
 for (String file : files) {
     System.out.println(file);
 }
 

Example, showing how to print out a list of the current directory's read-only files:

 File dir = FileUtils.current();
 String[] files = dir.list(CanReadFileFilter.READ_ONLY);
 for (String file : files) {
     System.out.println(file);
 }
 

Deprecating Serialization

Serialization is deprecated and will be removed in 3.0.

Since:

1.3

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static IOFileFilter	CAN_READ Singleton instance of readable filter
static IOFileFilter	CANNOT_READ Singleton instance of not readable filter
static IOFileFilter	READ_ONLY Singleton instance of read-only filter

Fields inherited from interface org.apache.commons.io.filefilter.IOFileFilter

EMPTY_STRING_ARRAY

Method Summary

Modifier and Type	Method and Description
boolean	accept(java.io.File file) Checks to see if the file can be read.
java.nio.file.FileVisitResult	accept(java.nio.file.Path file, java.nio.file.attribute.BasicFileAttributes attributes) Checks to see if the file can be read.

Methods inherited from class org.apache.commons.io.filefilter.AbstractFileFilter

accept, postVisitDirectory, preVisitDirectory, toString, visitFile, visitFileFailed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.io.filefilter.IOFileFilter

and, negate, or

Field Detail

CAN_READ

public static final IOFileFilter CAN_READ

Singleton instance of readable filter

CANNOT_READ

public static final IOFileFilter CANNOT_READ

Singleton instance of not readable filter

READ_ONLY

public static final IOFileFilter READ_ONLY

Singleton instance of read-only filter

Method Detail

accept

public boolean accept(java.io.File file)

Checks to see if the file can be read.

Specified by:

accept in interface java.io.FileFilter

Specified by:

accept in interface IOFileFilter

Overrides:

accept in class AbstractFileFilter

Parameters:

file - the File to check.

Returns:

true if the file can be read, otherwise false.

accept

public java.nio.file.FileVisitResult accept(java.nio.file.Path file,
                                            java.nio.file.attribute.BasicFileAttributes attributes)

Checks to see if the file can be read.

Specified by:

accept in interface PathFilter

Specified by:

accept in interface IOFileFilter

Parameters:

file - the File to check.

attributes - the file's basic attributes (TODO may be null).

Returns:

true if the file can be read, otherwise false.

Since:

2.9.0