SimpleFileVisitor
open class SimpleFileVisitor<T : Any!> : FileVisitor<T>
| kotlin.Any | |
| ↳ | java.nio.file.SimpleFileVisitor |
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 | |
|---|---|
|
Initializes a new instance of this class. |
|
| Public methods | |
|---|---|
| open FileVisitResult! |
postVisitDirectory(dir: T, exc: IOException!)Invoked for a directory after entries in the directory, and all of their descendants, have been visited. |
| open FileVisitResult! |
preVisitDirectory(dir: T, attrs: BasicFileAttributes!)Invoked for a directory before entries in the directory are visited. |
| open FileVisitResult! |
visitFile(file: T, attrs: BasicFileAttributes!)Invoked for a file in a directory. |
| open FileVisitResult! |
visitFileFailed(file: T, exc: IOException!)Invoked for a file that could not be visited. |
Protected constructors
SimpleFileVisitor
protected SimpleFileVisitor()
Initializes a new instance of this class.
Public methods
postVisitDirectory
open fun postVisitDirectory(
dir: T,
exc: IOException!
): FileVisitResult!
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 |
| Return | |
|---|---|
FileVisitResult! |
the visit result |
| Exceptions | |
|---|---|
java.io.IOException |
if an I/O error occurs |
preVisitDirectory
open fun preVisitDirectory(
dir: T,
attrs: BasicFileAttributes!
): FileVisitResult!
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 |
| Return | |
|---|---|
FileVisitResult! |
the visit result |
| Exceptions | |
|---|---|
java.io.IOException |
if an I/O error occurs |
visitFile
open fun visitFile(
file: T,
attrs: BasicFileAttributes!
): FileVisitResult!
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 |
| Return | |
|---|---|
FileVisitResult! |
the visit result |
| Exceptions | |
|---|---|
java.io.IOException |
if an I/O error occurs |
visitFileFailed
open fun visitFileFailed(
file: T,
exc: IOException!
): FileVisitResult!
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 |
| Return | |
|---|---|
FileVisitResult! |
the visit result |
| Exceptions | |
|---|---|
java.io.IOException |
if an I/O error occurs |