org.sejda.model.output

Enum ExistingOutputPolicy

java.lang.Object

java.lang.Enum<ExistingOutputPolicy>

org.sejda.model.output.ExistingOutputPolicy

All Implemented Interfaces:

Serializable, Comparable<ExistingOutputPolicy>, FriendlyNamed

public enum ExistingOutputPolicy
extends Enum<ExistingOutputPolicy>
implements FriendlyNamed

Possible policies to use in case of an existing output

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL
OVERWRITE
RENAME
SKIP

Method Summary

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

RENAME

public static final ExistingOutputPolicy RENAME

SKIP

public static final ExistingOutputPolicy SKIP

FAIL

public static final ExistingOutputPolicy FAIL

Method Detail

values

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

Returns:

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

valueOf

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

getFriendlyName

public String getFriendlyName()

Specified by:

getFriendlyName in interface FriendlyNamed

Returns:

the friendly name of the entity, to be usually used as a representation for an user.