org.jbake.model

Enum DocumentStatus

java.lang.Object

java.lang.Enum<DocumentStatus>

org.jbake.model.DocumentStatus

All Implemented Interfaces:

Serializable, Comparable<DocumentStatus>

public enum DocumentStatus
extends Enum<DocumentStatus>

Enumeration used to determine whether rendering of a document should be done.

Author:

Cédric Champeau

Enum Constant Summary

Enum Constants

Enum Constant and Description
IDENTICAL
NEW
REMOVED
UPDATED

Method Summary

Methods

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

NEW

public static final DocumentStatus NEW

UPDATED

public static final DocumentStatus UPDATED

REMOVED

public static final DocumentStatus REMOVED

IDENTICAL

public static final DocumentStatus IDENTICAL

Method Detail

values

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

Returns:

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

valueOf

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