org.mule.extension.file.common.api

Enum FileWriteMode

java.lang.Object

java.lang.Enum<FileWriteMode>

org.mule.extension.file.common.api.FileWriteMode

All Implemented Interfaces:

Serializable, Comparable<FileWriteMode>

public enum FileWriteMode
extends Enum<FileWriteMode>

List different strategies regarding how to write new files

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND Means that if the file to be written already exists, then the content should be appended to that file
CREATE_NEW Means that a new file should be created and an error should be raised if the file already exists
OVERWRITE Means that if the file to be written already exists, then it should be overwritten

Method Summary

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

OVERWRITE

public static final FileWriteMode OVERWRITE

Means that if the file to be written already exists, then it should be overwritten

APPEND

public static final FileWriteMode APPEND

Means that if the file to be written already exists, then the content should be appended to that file

CREATE_NEW

public static final FileWriteMode CREATE_NEW

Means that a new file should be created and an error should be raised if the file already exists

Method Detail

values

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

Returns:

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

valueOf

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