Package org.odpi.openmetadata.frameworks.governanceaction.properties

Enum Class OpenMetadataTypeDefStatus

java.lang.Object

java.lang.Enum<OpenMetadataTypeDefStatus>

org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefStatus

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataTypeDefStatus>, Constable

public enum OpenMetadataTypeDefStatus
extends Enum<OpenMetadataTypeDefStatus>
implements Serializable

OpenMetadataTypeDefStatus is an enum that describes the status of a specific typeDef.

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_TYPEDEF	ActiveTypeDef - OpenMetadataTypeDef available and in use.
DEPRECATED_TYPEDEF	DeprecatedTypeDef - This typeDef should not be used because it has been deprecated.
RENAMED_TYPEDEF	RenamedTypeDef - This typeDef should not be used because it has been renamed.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the status.
String	getName()	Return the descriptive name for the status.
int	getOrdinal()	Return the code value for the status.
String	toString()	toString() JSON-style
static OpenMetadataTypeDefStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenMetadataTypeDefStatus[]	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

ACTIVE_TYPEDEF

public static final OpenMetadataTypeDefStatus ACTIVE_TYPEDEF

ActiveTypeDef - OpenMetadataTypeDef available and in use. This is the default value equivalent to null.

RENAMED_TYPEDEF

public static final OpenMetadataTypeDefStatus RENAMED_TYPEDEF

RenamedTypeDef - This typeDef should not be used because it has been renamed.

DEPRECATED_TYPEDEF

public static final OpenMetadataTypeDefStatus DEPRECATED_TYPEDEF

DeprecatedTypeDef - This typeDef should not be used because it has been deprecated.

Method Details

values

public static OpenMetadataTypeDefStatus[] 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 OpenMetadataTypeDefStatus 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

getOrdinal

public int getOrdinal()

Return the code value for the status.

Returns:

int code

getName

public String getName()

Return the descriptive name for the status.

Returns:

String name

getDescription

public String getDescription()

Return the description of the status.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OpenMetadataTypeDefStatus>

Returns:

string description