SimpleFileVisitor
public class SimpleFileVisitor
extends Object
implements FileVisitor<T>
java.lang.Object | |
↳ | java.nio.file.SimpleFileVisitor<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.
Summary
Protected constructors | |
---|---|
SimpleFileVisitor() Initializes a new instance of this class. |
Public methods | |
---|---|
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 methods | |
---|---|
Protected constructors
SimpleFileVisitor
protected SimpleFileVisitor ()
Initializes a new instance of this class.
Public methods
postVisitDirectory
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 | T : a reference to the directory |
exc | IOException : 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 | |
---|---|
FileVisitResult | the visit result |
Throws | |
---|---|
IOException |
preVisitDirectory
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 | T : a reference to the directory |
attrs | BasicFileAttributes : the directory's basic attributes |
Returns | |
---|---|
FileVisitResult | the visit result |
Throws | |
---|---|
IOException |
visitFile
public FileVisitResult visitFile (T file, BasicFileAttributes attrs)
Invoked for a file in a directory.
Unless overridden, this method returns CONTINUE
.
Parameters | |
---|---|
file | T : a reference to the file |
attrs | BasicFileAttributes : the file's basic attributes |
Returns | |
---|---|
FileVisitResult | the visit result |
Throws | |
---|---|
IOException |
visitFileFailed
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 | T : a reference to the file |
exc | IOException : the I/O exception that prevented the file from being visited |
Returns | |
---|---|
FileVisitResult | the visit result |
Throws | |
---|---|
IOException |