org.odpi.openmetadata.frameworks.discovery.properties

Enum AnnotationStatus

java.lang.Object

java.lang.Enum<AnnotationStatus>

org.odpi.openmetadata.frameworks.discovery.properties.AnnotationStatus

All Implemented Interfaces:

Serializable, Comparable<AnnotationStatus>

public enum AnnotationStatus
extends Enum<AnnotationStatus>
implements Serializable

An AnnotationStatus defines the current status for an annotation plus some default descriptive text.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIONED_ANNOTATION
APPROVED_ANNOTATION
IGNORE_ANNOTATION
INVALID_ANNOTATION
NEW_ANNOTATION
OTHER_STATUS
REVIEWED_ANNOTATION
UNKNOWN_STATUS

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENUM_TYPE_GUID
static String	ENUM_TYPE_NAME

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the default description for the status for this enum instance.
String	getName() Return the default name for the status for this enum instance.
String	getOpenTypeGUID() Return the unique identifier for the open metadata enum type that this enum class represents.
String	getOpenTypeName() Return the unique name for the open metadata enum type that this enum class represents.
int	getOpenTypeOrdinal() Return the code for this enum that comes from the Open Metadata Type that this enum represents.
int	getOrdinal() Return the status code for this enum instance
String	toString() Standard toString method.
static AnnotationStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnnotationStatus[]	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

NEW_ANNOTATION

public static final AnnotationStatus NEW_ANNOTATION

REVIEWED_ANNOTATION

public static final AnnotationStatus REVIEWED_ANNOTATION

APPROVED_ANNOTATION

public static final AnnotationStatus APPROVED_ANNOTATION

ACTIONED_ANNOTATION

public static final AnnotationStatus ACTIONED_ANNOTATION

INVALID_ANNOTATION

public static final AnnotationStatus INVALID_ANNOTATION

IGNORE_ANNOTATION

public static final AnnotationStatus IGNORE_ANNOTATION

OTHER_STATUS

public static final AnnotationStatus OTHER_STATUS

UNKNOWN_STATUS

public static final AnnotationStatus UNKNOWN_STATUS

Field Detail

ENUM_TYPE_GUID

public static final String ENUM_TYPE_GUID

See Also:

Constant Field Values

ENUM_TYPE_NAME

public static final String ENUM_TYPE_NAME

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getOrdinal

public int getOrdinal()

Return the status code for this enum instance

Returns:

int status code

getName

public String getName()

Return the default name for the status for this enum instance.

Returns:

String default status name

getDescription

public String getDescription()

Return the default description for the status for this enum instance.

Returns:

String default status description

getOpenTypeOrdinal

public int getOpenTypeOrdinal()

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

Returns:

int code number

getOpenTypeGUID

public String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<AnnotationStatus>

Returns:

print out of variables in a JSON-style