org.sejda.model.optimization

Enum OptimizationPolicy

java.lang.Object

java.lang.Enum<OptimizationPolicy>

org.sejda.model.optimization.OptimizationPolicy

All Implemented Interfaces:

Serializable, Comparable<OptimizationPolicy>, FriendlyNamed

public enum OptimizationPolicy
extends Enum<OptimizationPolicy>
implements FriendlyNamed

Possible optimization policies to use on tasks generated documents

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO
NO
YES

Method Summary

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

YES

public static final OptimizationPolicy YES

NO

public static final OptimizationPolicy NO

AUTO

public static final OptimizationPolicy AUTO

Method Detail

values

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

Returns:

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

valueOf

public static OptimizationPolicy 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.