Skip navigation links

waggle.common.modules.document.enums
Enum XRenditionState

java.lang.Object
java.lang.Enum<XRenditionState>
waggle.common.modules.document.enums.XRenditionState

All Implemented Interfaces:

Serializable, Comparable<XRenditionState>

public enum XRenditionState

extends Enum<XRenditionState>

State of a rendition (which could be a PDF rendition, a thumbnail image, or a set of page images).

Enum Constant Summary

FAILED
Generation of the rendition failed.

NOT_READY_YET
Rendition is not available yet, but there is reason to believe it will be in the future.

NOT_SUPPORTED
Rendition is not supported for this object/document type.

READY
Rendition is available and ready for use.

Method Summary

static XRenditionState	valueOf(String name) Returns the enum constant of this type with the specified name.
static XRenditionState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

READY

public static final XRenditionState READY

Rendition is available and ready for use.

NOT_READY_YET

public static final XRenditionState NOT_READY_YET

Rendition is not available yet, but there is reason to believe it will be in the future.

NOT_SUPPORTED

public static final XRenditionState NOT_SUPPORTED

Rendition is not supported for this object/document type.

FAILED

public static final XRenditionState FAILED

Generation of the rendition failed. Do not expect it to become available.

Method Detail

values

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

Returns:

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

valueOf

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

Skip navigation links