Package org.apache.commons.io.file

Class CleaningPathVisitor

java.lang.Object

java.nio.file.SimpleFileVisitor<Path>

org.apache.commons.io.file.SimplePathVisitor

org.apache.commons.io.file.CountingPathVisitor

org.apache.commons.io.file.CleaningPathVisitor

All Implemented Interfaces:

FileVisitor<Path>, PathVisitor

public class CleaningPathVisitor
extends CountingPathVisitor

Deletes files but not directories as a visit proceeds.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	overrideReadOnly
private final String[]	skip

Fields inherited from class org.apache.commons.io.file.CountingPathVisitor

EMPTY_STRING_ARRAY

Constructor Summary

Constructors

Constructor	Description
CleaningPathVisitor(Counters.PathCounters pathCounter, String... skip)	Constructs a new visitor that deletes files except for the files and directories explicitly given.
CleaningPathVisitor(Counters.PathCounters pathCounter, DeleteOption[] deleteOption, String... skip)	Constructs a new visitor that deletes files except for the files and directories explicitly given.

Method Summary

Modifier and Type	Method	Description
private boolean	accept(Path path)	Returns true to process the given path, false if not.
boolean	equals(Object obj)
int	hashCode()
FileVisitResult	preVisitDirectory(Path dir, BasicFileAttributes attributes)
FileVisitResult	visitFile(Path file, BasicFileAttributes attributes)
static CountingPathVisitor	withBigIntegerCounters()	Creates a new instance configured with a BigInteger Counters.PathCounters.
static CountingPathVisitor	withLongCounters()	Creates a new instance configured with a long Counters.PathCounters.

Methods inherited from class org.apache.commons.io.file.CountingPathVisitor

getPathCounters, postVisitDirectory, toString, updateDirCounter, updateFileCounters

Methods inherited from class java.nio.file.SimpleFileVisitor

visitFileFailed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.nio.file.FileVisitor

visitFileFailed

Field Details

skip

private final String[] skip

overrideReadOnly

private final boolean overrideReadOnly

Constructor Details

CleaningPathVisitor

public CleaningPathVisitor(Counters.PathCounters pathCounter,
 DeleteOption[] deleteOption,
 String... skip)

Constructs a new visitor that deletes files except for the files and directories explicitly given.

Parameters:

pathCounter - How to count visits.

deleteOption - How deletion is handled.

skip - The files to skip deleting.

Since:

2.8.0

CleaningPathVisitor

public CleaningPathVisitor(Counters.PathCounters pathCounter,
 String... skip)

Constructs a new visitor that deletes files except for the files and directories explicitly given.

Parameters:

pathCounter - How to count visits.

skip - The files to skip deleting.

Method Details

withBigIntegerCounters

public static CountingPathVisitor withBigIntegerCounters()

Creates a new instance configured with a BigInteger Counters.PathCounters.

Returns:

a new instance configured with a BigInteger Counters.PathCounters.

withLongCounters

public static CountingPathVisitor withLongCounters()

Creates a new instance configured with a long Counters.PathCounters.

Returns:

a new instance configured with a long Counters.PathCounters.

accept

private boolean accept(Path path)

Returns true to process the given path, false if not.

Parameters:

path - the path to test.

Returns:

true to process the given path, false if not.

equals

public boolean equals(Object obj)

Overrides:

equals in class CountingPathVisitor

hashCode

public int hashCode()

Overrides:

hashCode in class CountingPathVisitor

preVisitDirectory

public FileVisitResult preVisitDirectory(Path dir,
 BasicFileAttributes attributes)
                                  throws IOException

Specified by:

preVisitDirectory in interface FileVisitor<Path>

Overrides:

preVisitDirectory in class CountingPathVisitor

Throws:

IOException

visitFile

public FileVisitResult visitFile(Path file,
 BasicFileAttributes attributes)
                          throws IOException

Specified by:

visitFile in interface FileVisitor<Path>

Overrides:

visitFile in class CountingPathVisitor

Throws:

IOException