org.osivia.portal.api.cms

Enum DocumentState

java.lang.Object

java.lang.Enum<DocumentState>

org.osivia.portal.api.cms.DocumentState

All Implemented Interfaces:

Serializable, Comparable<DocumentState>

public enum DocumentState
extends Enum<DocumentState>

State of a document

Author:

Loïc Billon

Enum Constant Summary

Enum Constants

Enum Constant and Description
INHERITED show the state depending of his parents state
LIVE live (draft)
PUBLISHED published

Method Summary

Modifier and Type	Method and Description
DocumentState	parse(Boolean b)
static DocumentState	parse(String s)
String	toString()
static DocumentState	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LIVE

public static final DocumentState LIVE

live (draft)

PUBLISHED

public static final DocumentState PUBLISHED

published

INHERITED

public static final DocumentState INHERITED

show the state depending of his parents state

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static DocumentState parse(String s)

parse

public DocumentState parse(Boolean b)

toString

public String toString()

Overrides:

toString in class Enum<DocumentState>