Package org.apache.commons.io.file
Class CountingPathVisitor
java.lang.Object
java.nio.file.SimpleFileVisitor<Path>
org.apache.commons.io.file.SimplePathVisitor
org.apache.commons.io.file.CountingPathVisitor
- All Implemented Interfaces:
FileVisitor<Path>
,PathVisitor
- Direct Known Subclasses:
AccumulatorPathVisitor
,CleaningPathVisitor
,CopyDirectoryVisitor
,DeletingPathVisitor
Counts files, directories, and sizes, as a visit proceeds.
- Since:
- 2.7
-
Constructor Summary
ConstructorsConstructorDescriptionCountingPathVisitor
(Counters.PathCounters pathCounter) Constructs a new instance.CountingPathVisitor
(Counters.PathCounters pathCounter, PathFilter fileFilter, PathFilter dirFilter) Constructs a new instance. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Gets the visitation counts.int
hashCode()
postVisitDirectory
(Path dir, IOException exc) preVisitDirectory
(Path dir, BasicFileAttributes attributes) toString()
protected void
updateDirCounter
(Path dir, IOException exc) Updates the counter for visiting the given directory.protected void
updateFileCounters
(Path file, BasicFileAttributes attributes) Updates the counters for visiting the given file.visitFile
(Path file, BasicFileAttributes attributes) static CountingPathVisitor
Creates a new instance configured with a BigIntegerCounters.PathCounters
.static CountingPathVisitor
Creates a new instance configured with a longCounters.PathCounters
.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
-
Constructor Details
-
CountingPathVisitor
Constructs a new instance.- Parameters:
pathCounter
- How to count path visits.
-
CountingPathVisitor
public CountingPathVisitor(Counters.PathCounters pathCounter, PathFilter fileFilter, PathFilter dirFilter) Constructs a new instance.- Parameters:
pathCounter
- How to count path visits.fileFilter
- Filters which files to count.dirFilter
- Filters which directories to count.- Since:
- 2.9.0
-
-
Method Details
-
withBigIntegerCounters
Creates a new instance configured with a BigIntegerCounters.PathCounters
.- Returns:
- a new instance configured with a BigInteger
Counters.PathCounters
.
-
withLongCounters
Creates a new instance configured with a longCounters.PathCounters
.- Returns:
- a new instance configured with a long
Counters.PathCounters
.
-
equals
-
getPathCounters
Gets the visitation counts.- Returns:
- the visitation counts.
-
hashCode
-
postVisitDirectory
- Specified by:
postVisitDirectory
in interfaceFileVisitor<Path>
- Overrides:
postVisitDirectory
in classSimpleFileVisitor<Path>
- Throws:
IOException
-
preVisitDirectory
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attributes) throws IOException - Specified by:
preVisitDirectory
in interfaceFileVisitor<Path>
- Overrides:
preVisitDirectory
in classSimpleFileVisitor<Path>
- Throws:
IOException
-
toString
-
updateDirCounter
Updates the counter for visiting the given directory.- Parameters:
dir
- the visited directory.exc
- Encountered exception.- Since:
- 2.9.0
-
updateFileCounters
Updates the counters for visiting the given file.- Parameters:
file
- the visited file.attributes
- the visited file attributes.
-
visitFile
- Specified by:
visitFile
in interfaceFileVisitor<Path>
- Overrides:
visitFile
in classSimpleFileVisitor<Path>
- Throws:
IOException
-