Enum FileVisitResult

java.lang.Object
- java.lang.Enum<FileVisitResult>
- - java.nio.file.FileVisitResult

All Implemented Interfaces:: Serializable, Comparable<FileVisitResult>

public enum FileVisitResult
extends Enum<FileVisitResult>

The result type of a FileVisitor.

Since:: 1.7
See Also:: Files.walkFileTree(java.nio.file.Path, java.util.Set<java.nio.file.FileVisitOption>, int, java.nio.file.FileVisitor<? super java.nio.file.Path>)

Enum Constants

Enum Constant and Description
`CONTINUE` Continue.
`SKIP_SIBLINGS` Continue without visiting the siblings of this file or directory.
`SKIP_SUBTREE` Continue without visiting the entries in this directory.
`TERMINATE` Terminate.

Methods

Modifier and Type	Method and Description
`static FileVisitResult`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static FileVisitResult[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constants

CONTINUE

public static final FileVisitResult CONTINUE

Continue. When returned from a preVisitDirectory method then the entries in the directory should also be visited.

TERMINATE

public static final FileVisitResult TERMINATE

Terminate.

SKIP_SUBTREE

public static final FileVisitResult SKIP_SUBTREE

Continue without visiting the entries in this directory. This result is only meaningful when returned from the preVisitDirectory method; otherwise this result type is the same as returning CONTINUE.

SKIP_SIBLINGS

public static final FileVisitResult SKIP_SIBLINGS

Continue without visiting the siblings of this file or directory. If returned from the preVisitDirectory method then the entries in the directory are also skipped and the postVisitDirectory method is not invoked.

Methods

values

public static FileVisitResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FileVisitResult c : FileVisitResult.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileVisitResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: IllegalArgumentException - if this enum type has no constant with the specified name; NullPointerException - if the argument is null

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/java/nio/file/FileVisitResult.html