Package com.atlassian.adf.model

Enum Documentation.State

java.lang.Object

java.lang.Enum<Documentation.State>

com.atlassian.adf.model.Documentation.State

All Implemented Interfaces:

Serializable, Comparable<Documentation.State>

Enclosing class:

Documentation

public static enum Documentation.State
extends Enum<Documentation.State>

Expresses that library's author on the state of the Jira ADF Documentation for this item (whether it is a mark, a node, or a property of either) at the time of its more recent review on Documentation.date().

Enum Constant Summary

Enum Constants

Enum Constant	Description
INCOMPLETE	The existing documentation is correct, but some of the features are not included in the documentation or their values are not fully explained.
REVIEWED	The contents were complete and up-to-date as of the review date.
UNDOCUMENTED	There is no existing documentation of this feature.
WRONG	The existing documentation contains information that is incorrect or misleading.

Method Summary

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

REVIEWED

public static final Documentation.State REVIEWED

The contents were complete and up-to-date as of the review date.

UNDOCUMENTED

public static final Documentation.State UNDOCUMENTED

There is no existing documentation of this feature.

INCOMPLETE

public static final Documentation.State INCOMPLETE

The existing documentation is correct, but some of the features are not included in the documentation or their values are not fully explained.

WRONG

public static final Documentation.State WRONG

The existing documentation contains information that is incorrect or misleading.

Method Detail

values

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

Returns:

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

valueOf

public static Documentation.State 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