com.ibm.cos.v2.core

Enum FileTransformerConfiguration.FileWriteOption

java.lang.Object

java.lang.Enum<FileTransformerConfiguration.FileWriteOption>

com.ibm.cos.v2.core.FileTransformerConfiguration.FileWriteOption

All Implemented Interfaces:

Serializable, Comparable<FileTransformerConfiguration.FileWriteOption>

Enclosing class:

FileTransformerConfiguration

public static enum FileTransformerConfiguration.FileWriteOption
extends Enum<FileTransformerConfiguration.FileWriteOption>

Defines how the SDK should write the file

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE_NEW Always create a new file.
CREATE_OR_APPEND_TO_EXISTING Create a new file if it doesn't exist, otherwise append to the existing file.
CREATE_OR_REPLACE_EXISTING Create a new file if it doesn't exist, otherwise replace the existing file.
WRITE_TO_POSITION Write to an existing file at the specified position, defined by the FileTransformerConfiguration.position().

Method Summary

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

public static final FileTransformerConfiguration.FileWriteOption CREATE_NEW

Always create a new file. If the file already exists, FileAlreadyExistsException will be thrown.

CREATE_OR_REPLACE_EXISTING

public static final FileTransformerConfiguration.FileWriteOption CREATE_OR_REPLACE_EXISTING

Create a new file if it doesn't exist, otherwise replace the existing file.

CREATE_OR_APPEND_TO_EXISTING

public static final FileTransformerConfiguration.FileWriteOption CREATE_OR_APPEND_TO_EXISTING

Create a new file if it doesn't exist, otherwise append to the existing file.

WRITE_TO_POSITION

public static final FileTransformerConfiguration.FileWriteOption WRITE_TO_POSITION

Write to an existing file at the specified position, defined by the FileTransformerConfiguration.position(). If the file does not exist, a NoSuchFileException will be thrown. If FileTransformerConfiguration.position() is not configured, start overwriting data at the beginning of the file (byte 0).

Method Detail

values

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

Returns:

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

valueOf

public static FileTransformerConfiguration.FileWriteOption 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