SimpleFileVisitor

AI-generated Key Takeaways

• SimpleFileVisitor provides a basic implementation of the FileVisitor interface with default behaviors for file traversal.

• It offers methods to handle directory visits before and after processing entries, as well as individual file visits and failures.

• By default, it visits all files and re-throws any encountered I/O errors during the process.

• The methods in SimpleFileVisitor can be overridden to customize file and directory handling logic during traversal.

public class SimpleFileVisitor extends Object
implements FileVisitor<T>

A simple visitor of files with default behavior to visit all files and to re-throw I/O errors.

Methods in this class may be overridden subject to their general contract.

Protected Constructor Summary

SimpleFileVisitor() Initializes a new instance of this class.

Public Method Summary

FileVisitResult	postVisitDirectory(T dir, IOException exc) Invoked for a directory after entries in the directory, and all of their descendants, have been visited.
FileVisitResult	preVisitDirectory(T dir, BasicFileAttributes attrs) Invoked for a directory before entries in the directory are visited.
FileVisitResult	visitFile(T file, BasicFileAttributes attrs) Invoked for a file in a directory.
FileVisitResult	visitFileFailed(T file, IOException exc) Invoked for a file that could not be visited.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.nio.file.FileVisitor

abstract FileVisitResult	postVisitDirectory(T dir, IOException exc) Invoked for a directory after entries in the directory, and all of their descendants, have been visited.
abstract FileVisitResult	preVisitDirectory(T dir, BasicFileAttributes attrs) Invoked for a directory before entries in the directory are visited.
abstract FileVisitResult	visitFile(T file, BasicFileAttributes attrs) Invoked for a file in a directory.
abstract FileVisitResult	visitFileFailed(T file, IOException exc) Invoked for a file that could not be visited.

Protected Constructors

protected SimpleFileVisitor ()

Initializes a new instance of this class.

Public Methods

public FileVisitResult postVisitDirectory (T dir, IOException exc)

Invoked for a directory after entries in the directory, and all of their descendants, have been visited.

Unless overridden, this method returns CONTINUE if the directory iteration completes without an I/O exception; otherwise this method re-throws the I/O exception that caused the iteration of the directory to terminate prematurely.

Parameters

dir	a reference to the directory
exc	null if the iteration of the directory completes without an error; otherwise the I/O exception that caused the iteration of the directory to complete prematurely

Returns

• the visit result

Throws

IOException

public FileVisitResult preVisitDirectory (T dir, BasicFileAttributes attrs)

Invoked for a directory before entries in the directory are visited.

Unless overridden, this method returns CONTINUE.

Parameters

dir	a reference to the directory
attrs	the directory's basic attributes

Returns

• the visit result

Throws

IOException

public FileVisitResult visitFile (T file, BasicFileAttributes attrs)

Invoked for a file in a directory.

Unless overridden, this method returns CONTINUE.

Parameters

file	a reference to the file
attrs	the file's basic attributes

Returns

• the visit result

Throws

IOException

public FileVisitResult visitFileFailed (T file, IOException exc)

Invoked for a file that could not be visited.

Unless overridden, this method re-throws the I/O exception that prevented the file from being visited.

Parameters

file	a reference to the file
exc	the I/O exception that prevented the file from being visited

Returns

• the visit result

Throws

IOException