org.kocakosm.pitaya.io

Enum WriteOption

java.lang.Object

java.lang.Enum<WriteOption>

org.kocakosm.pitaya.io.WriteOption

All Implemented Interfaces:

Serializable, Comparable<WriteOption>

public enum WriteOption
extends Enum<WriteOption>

File write options.

Author:

Osman KOCAK

See Also:

XFiles, TextFiles

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND Append data at the end of the file.
CREATE Create a new file, failing if the file already exists.
OVERWRITE Overwrite the file (without first truncating it).
UPDATE Update an existing file, failing if the file doesn't exist.

Method Summary

Methods

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

CREATE

public static final WriteOption CREATE

Create a new file, failing if the file already exists. Can't be used together with UPDATE, OVERWRITE and APPEND.

UPDATE

public static final WriteOption UPDATE

Update an existing file, failing if the file doesn't exist. Can't be used together with CREATE.

OVERWRITE

public static final WriteOption OVERWRITE

Overwrite the file (without first truncating it). Can't be used together with CREATE and APPEND.

APPEND

public static final WriteOption APPEND

Append data at the end of the file. Can't be used together with CREATE and OVERWRITE.

Method Detail

values

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

Returns:

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

valueOf

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