FileVisitResult

AI-generated Key Takeaways

• FileVisitResult is an enum that defines the outcome of a file visit operation by a FileVisitor.

• It's primarily used with Files.walkFileTree for controlling directory traversal.

• The enum provides four key values: CONTINUE, SKIP_SIBLINGS, SKIP_SUBTREE, and TERMINATE, each dictating how the file tree walk should proceed.

• These values allow developers to fine-tune file and directory traversal behavior during operations like searching, copying, or deleting files within a file system.

public final enum FileVisitResult extends Enum<FileVisitResult>

The result type of a FileVisitor.

See Also

• Files.walkFileTree(Path, FileVisitor)

Inherited Method Summary

From class java.lang.Enum

final Object	clone() Throws CloneNotSupportedException.
final int	compareTo(FileVisitResult o) Compares this enum with the specified object for order.
final boolean	equals(Object other) Returns true if the specified object is equal to this enum constant.
final void	finalize() enum classes cannot have finalize methods.
final Class<FileVisitResult>	getDeclaringClass() Returns the Class object corresponding to this enum constant's enum type.
final int	hashCode() Returns a hash code for this enum constant.
final String	name() Returns the name of this enum constant, exactly as declared in its enum declaration.
final int	ordinal() Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
String	toString() Returns the name of this enum constant, as contained in the declaration.
static <T extends Enum<T>> T	valueOf(Class<T> enumType, String name) Returns the enum constant of the specified enum type with the specified name.

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.lang.Comparable

abstract int

compareTo(FileVisitResult o) Compares this object with the specified object for order.

Enum Values

public static final FileVisitResult CONTINUE

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

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.

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.

public static final FileVisitResult TERMINATE

Terminate.