org.apache.commons.io.file

Class DeletingPathVisitor

java.lang.Object

java.nio.file.SimpleFileVisitor<java.nio.file.Path>

org.apache.commons.io.file.SimplePathVisitor

org.apache.commons.io.file.CountingPathVisitor

org.apache.commons.io.file.DeletingPathVisitor

All Implemented Interfaces:

java.nio.file.FileVisitor<java.nio.file.Path>, PathVisitor

public class DeletingPathVisitor
extends CountingPathVisitor

Deletes files and directories as a visit proceeds.

Since:

2.7

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.file.LinkOption[]	linkOptions
private boolean	overrideReadOnly
private java.lang.String[]	skip

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

EMPTY_STRING_ARRAY

Constructor Summary

Constructors

Constructor and Description
DeletingPathVisitor(Counters.PathCounters pathCounter, DeleteOption[] deleteOption, java.lang.String... skip) Constructs a new visitor that deletes files except for the files and directories explicitly given.
DeletingPathVisitor(Counters.PathCounters pathCounter, java.nio.file.LinkOption[] linkOptions, DeleteOption[] deleteOption, java.lang.String... skip) Constructs a new visitor that deletes files except for the files and directories explicitly given.
DeletingPathVisitor(Counters.PathCounters pathCounter, java.lang.String... skip) Constructs a new visitor that deletes files except for the files and directories explicitly given.

Method Summary

Modifier and Type	Method and Description
private boolean	accept(java.nio.file.Path path) Returns true to process the given path, false if not.
boolean	equals(java.lang.Object obj)
int	hashCode()
java.nio.file.FileVisitResult	postVisitDirectory(java.nio.file.Path dir, java.io.IOException exc)
java.nio.file.FileVisitResult	preVisitDirectory(java.nio.file.Path dir, java.nio.file.attribute.BasicFileAttributes attrs)
java.nio.file.FileVisitResult	visitFile(java.nio.file.Path file, java.nio.file.attribute.BasicFileAttributes attrs)
static DeletingPathVisitor	withBigIntegerCounters() Constructs a new instance configured with a BigInteger Counters.PathCounters.
static DeletingPathVisitor	withLongCounters() Constructs a new instance configured with a long Counters.PathCounters.

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

defaultDirFilter, defaultFileFilter, getPathCounters, toString, updateDirCounter, updateFileCounters

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

visitFileFailed

Methods inherited from class java.lang.Object

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

Field Detail

skip

private final java.lang.String[] skip

overrideReadOnly

private final boolean overrideReadOnly

linkOptions

private final java.nio.file.LinkOption[] linkOptions

Constructor Detail

DeletingPathVisitor

public DeletingPathVisitor(Counters.PathCounters pathCounter,
                           DeleteOption[] deleteOption,
                           java.lang.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

DeletingPathVisitor

public DeletingPathVisitor(Counters.PathCounters pathCounter,
                           java.nio.file.LinkOption[] linkOptions,
                           DeleteOption[] deleteOption,
                           java.lang.String... skip)

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

Parameters:

pathCounter - How to count visits.

linkOptions - How symbolic links are handled.

deleteOption - How deletion is handled.

skip - The files to skip deleting.

Since:

2.9.0

DeletingPathVisitor

public DeletingPathVisitor(Counters.PathCounters pathCounter,
                           java.lang.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 Detail

withBigIntegerCounters

public static DeletingPathVisitor withBigIntegerCounters()

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

Returns:

a new instance configured with a BigInteger Counters.PathCounters.

withLongCounters

public static DeletingPathVisitor withLongCounters()

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

Returns:

a new instance configured with a long Counters.PathCounters.

accept

private boolean accept(java.nio.file.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(java.lang.Object obj)

Overrides:

equals in class CountingPathVisitor

hashCode

public int hashCode()

Overrides:

hashCode in class CountingPathVisitor

postVisitDirectory

public java.nio.file.FileVisitResult postVisitDirectory(java.nio.file.Path dir,
                                                        java.io.IOException exc)
                                                 throws java.io.IOException

Specified by:

postVisitDirectory in interface java.nio.file.FileVisitor<java.nio.file.Path>

Overrides:

postVisitDirectory in class CountingPathVisitor

Throws:

java.io.IOException

preVisitDirectory

public java.nio.file.FileVisitResult preVisitDirectory(java.nio.file.Path dir,
                                                       java.nio.file.attribute.BasicFileAttributes attrs)
                                                throws java.io.IOException

Specified by:

preVisitDirectory in interface java.nio.file.FileVisitor<java.nio.file.Path>

Overrides:

preVisitDirectory in class CountingPathVisitor

Throws:

java.io.IOException

visitFile

public java.nio.file.FileVisitResult visitFile(java.nio.file.Path file,
                                               java.nio.file.attribute.BasicFileAttributes attrs)
                                        throws java.io.IOException

Specified by:

visitFile in interface java.nio.file.FileVisitor<java.nio.file.Path>

Overrides:

visitFile in class CountingPathVisitor

Throws:

java.io.IOException