org.jbake.model

Enum DocumentAttributes

java.lang.Object

java.lang.Enum<DocumentAttributes>

org.jbake.model.DocumentAttributes

All Implemented Interfaces:

Serializable, Comparable<DocumentAttributes>

public enum DocumentAttributes
extends Enum<DocumentAttributes>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CACHED
RENDERED
SHA1
SOURCE_URI

Method Summary

Methods

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

SHA1

public static final DocumentAttributes SHA1

SOURCE_URI

public static final DocumentAttributes SOURCE_URI

RENDERED

public static final DocumentAttributes RENDERED

CACHED

public static final DocumentAttributes CACHED

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<DocumentAttributes>