Package org.odpi.openmetadata.frameworks.integration.bitol.common

Enum Class BitolStatus

java.lang.Object

java.lang.Enum<BitolStatus>

org.odpi.openmetadata.frameworks.integration.bitol.common.BitolStatus

All Implemented Interfaces:

Serializable, Comparable<BitolStatus>, Constable

public enum BitolStatus
extends Enum<BitolStatus>

BitolStatus lists the standard lifecycle status values of a Bitol data contract (ODCS) or data product (ODPS). The Bitol standards carry these values as strings, and permit additional values, so the beans hold the string and this enumeration documents the standard values and provides a lookup.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	The document is in force and the data is available for use.
DEPRECATED	The document is still in force but consumers should migrate away from it.
DRAFT	The document is being drafted and is not yet ready for use.
PROPOSED	The document has been proposed but not yet worked on.
RETIRED	The document is no longer in force and the data is no longer available.

Method Summary

Modifier and Type	Method	Description
static BitolStatus	fromValue(String value)	Return the enumeration that matches the supplied document value (case-insensitive).
String	getDescription()	Return the description of the meaning of the value.
String	getValue()	Return the string used in the document.
String	toString()	Standard toString method.
static BitolStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BitolStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PROPOSED

public static final BitolStatus PROPOSED

The document has been proposed but not yet worked on.

DRAFT

public static final BitolStatus DRAFT

The document is being drafted and is not yet ready for use.

ACTIVE

public static final BitolStatus ACTIVE

The document is in force and the data is available for use.

DEPRECATED

public static final BitolStatus DEPRECATED

The document is still in force but consumers should migrate away from it.

RETIRED

public static final BitolStatus RETIRED

The document is no longer in force and the data is no longer available.

Method Details

values

public static BitolStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BitolStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Return the string used in the document.

Returns:

string value

getDescription

public String getDescription()

Return the description of the meaning of the value.

Returns:

string description

fromValue

public static BitolStatus fromValue(String value)

Return the enumeration that matches the supplied document value (case-insensitive).

Parameters:

value - string from the document

Returns:

matching enumeration or null if the value is not one of the standard values

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<BitolStatus>

Returns:

print out of variables in a JSON-style