Javadoc: CountingPathVisitor (Apache Commons IO 2.11.0 API)

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
```
public class CountingPathVisitor
extends SimplePathVisitor
```
Counts files, directories, and sizes, as a visit proceeds.

Since:

2.7

Constructor Summary

Constructors
Constructor and Description
`CountingPathVisitor(Counters.PathCounters pathCounter)` Constructs a new instance.
`CountingPathVisitor(Counters.PathCounters pathCounter, PathFilter fileFilter, PathFilter dirFilter)` Constructs a new instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Counters.PathCounters`	`getPathCounters()` Gets the visitation counts.
`int`	`hashCode()`
`FileVisitResult`	`postVisitDirectory(Path dir, IOException exc)`
`FileVisitResult`	`preVisitDirectory(Path dir, BasicFileAttributes attributes)`
`String`	`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.
`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 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 Detail
  - CountingPathVisitor
```
public CountingPathVisitor(Counters.PathCounters pathCounter)
```
    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 Detail
  - 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.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getPathCounters
```
public Counters.PathCounters getPathCounters()
```
    Gets the visitation counts.
    
    Returns:
    
    the visitation counts.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - postVisitDirectory
```
public FileVisitResult postVisitDirectory(Path dir,
                                          IOException exc)
                                   throws IOException
```
    Specified by:
    
    postVisitDirectory in interface FileVisitor<Path>
    
    Overrides:
    
    postVisitDirectory in class SimpleFileVisitor<Path>
    
    Throws:
    
    IOException
  - preVisitDirectory
```
public FileVisitResult preVisitDirectory(Path dir,
                                         BasicFileAttributes attributes)
                                  throws IOException
```
    Specified by:
    
    preVisitDirectory in interface FileVisitor<Path>
    
    Overrides:
    
    preVisitDirectory in class SimpleFileVisitor<Path>
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - updateDirCounter
```
protected void updateDirCounter(Path dir,
                                IOException exc)
```
    Updates the counter for visiting the given directory.
    
    Parameters:
    
    dir - the visited directory.
    
    exc - Encountered exception.
    
    Since:
    
    2.9.0
  - updateFileCounters
```
protected void updateFileCounters(Path file,
                                  BasicFileAttributes attributes)
```
    Updates the counters for visiting the given file.
    
    Parameters:
    
    file - the visited file.
    
    attributes - the visited file attributes.
  - visitFile
```
public FileVisitResult visitFile(Path file,
                                 BasicFileAttributes attributes)
                          throws IOException
```
    Specified by:
    
    visitFile in interface FileVisitor<Path>
    
    Overrides:
    
    visitFile in class SimpleFileVisitor<Path>
    
    Throws:
    
    IOException

Group Id	commons-io
Artifact Id	commons-io
Version	2.11.0
Last Release	2.11.0
Navigation	Index Tree Use Deprecated Help
Last Updated	2021-07-10

Class CountingPathVisitor

Constructor Summary

Method Summary

Methods inherited from class java.nio.file.SimpleFileVisitor

Methods inherited from class java.lang.Object

Methods inherited from interface java.nio.file.FileVisitor

Constructor Detail

CountingPathVisitor

CountingPathVisitor

Method Detail

withBigIntegerCounters

withLongCounters

equals

getPathCounters

hashCode

postVisitDirectory

preVisitDirectory

toString

updateDirCounter

updateFileCounters

visitFile