Package com.google.common.io

Enum RecursiveDeleteOption

java.lang.Object

java.lang.Enum<RecursiveDeleteOption>

com.google.common.io.RecursiveDeleteOption

All Implemented Interfaces:

Serializable, Comparable<RecursiveDeleteOption>

@GwtIncompatible
@J2ObjCIncompatible
public enum RecursiveDeleteOption
extends Enum<RecursiveDeleteOption>

Options for use with recursive delete methods (MoreFiles.deleteRecursively(java.nio.file.Path, com.google.common.io.RecursiveDeleteOption...) and MoreFiles.deleteDirectoryContents(java.nio.file.Path, com.google.common.io.RecursiveDeleteOption...)).

Since:

33.4.0 (but since 21.0 in the JRE flavor)

Author:

Colin Decker

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW_INSECURE	Specifies that the recursive delete should not throw an exception when it can't be guaranteed that it can be done securely, without vulnerability to race conditions (i.e. when the file system does not support SecureDirectoryStream).

Method Summary

Modifier and Type	Method	Description
static RecursiveDeleteOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RecursiveDeleteOption[]	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 Constant Detail

ALLOW_INSECURE

public static final RecursiveDeleteOption ALLOW_INSECURE

Specifies that the recursive delete should not throw an exception when it can't be guaranteed that it can be done securely, without vulnerability to race conditions (i.e. when the file system does not support SecureDirectoryStream).

Warning: On a file system that supports symbolic links, it is possible for an insecure recursive delete to delete files and directories that are outside the directory being deleted. This can happen if, after checking that a file is a directory (and not a symbolic link), that directory is deleted and replaced by a symbolic link to an outside directory before the call that opens the directory to read its entries. File systems that support SecureDirectoryStream do not have this vulnerability.

Method Detail

values

public static RecursiveDeleteOption[] 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 (RecursiveDeleteOption c : RecursiveDeleteOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static RecursiveDeleteOption 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