org.apache.flink.core.fs

Enum FileSystem.WriteMode

java.lang.Object

java.lang.Enum<FileSystem.WriteMode>

org.apache.flink.core.fs.FileSystem.WriteMode

All Implemented Interfaces:

Serializable, Comparable<FileSystem.WriteMode>

Enclosing class:

FileSystem

public static enum FileSystem.WriteMode
extends Enum<FileSystem.WriteMode>

The possible write modes. The write mode decides what happens if a file should be created, but already exists.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_OVERWRITE Creates the target file only if no file exists at that path already.
OVERWRITE Creates a new target file regardless of any existing files or directories.

Method Summary

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

NO_OVERWRITE

public static final FileSystem.WriteMode NO_OVERWRITE

Creates the target file only if no file exists at that path already. Does not overwrite existing files and directories.

OVERWRITE

public static final FileSystem.WriteMode OVERWRITE

Creates a new target file regardless of any existing files or directories. Existing files and directories will be deleted (recursively) automatically before creating the new file.

Method Detail

values

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

Returns:

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

valueOf

public static FileSystem.WriteMode 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