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

Enum Class OpenMetadataTypeDefCategory

java.lang.Object

java.lang.Enum<OpenMetadataTypeDefCategory>

org.odpi.openmetadata.frameworks.governanceaction.properties.OpenMetadataTypeDefCategory

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataTypeDefCategory>, Constable

public enum OpenMetadataTypeDefCategory
extends Enum<OpenMetadataTypeDefCategory>
implements Serializable

The OpenMetadataTypeDefCategory defines the list of valid types of OpenMetadataTypeDef for open metadata instances.

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
CLASSIFICATION_DEF	OpenMetadataClassificationDef - A description of a specific characteristic or grouping for entities.
ENTITY_DEF	OpenMetadataEntityDef - An object or concept of interest.
RELATIONSHIP_DEF	OpenMetadataRelationshipDef - A link between two entities.
UNKNOWN_DEF	Unknown - Uninitialized OpenMetadataTypeDef object.

Method Summary

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

UNKNOWN_DEF

public static final OpenMetadataTypeDefCategory UNKNOWN_DEF

Unknown - Uninitialized OpenMetadataTypeDef object.

CLASSIFICATION_DEF

public static final OpenMetadataTypeDefCategory CLASSIFICATION_DEF

OpenMetadataClassificationDef - A description of a specific characteristic or grouping for entities.

ENTITY_DEF

public static final OpenMetadataTypeDefCategory ENTITY_DEF

OpenMetadataEntityDef - An object or concept of interest.

RELATIONSHIP_DEF

public static final OpenMetadataTypeDefCategory RELATIONSHIP_DEF

OpenMetadataRelationshipDef - A link between two entities.

Method Details

values

public static OpenMetadataTypeDefCategory[] 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 OpenMetadataTypeDefCategory 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 for this enum instance

Returns:

int type code

getName

public String getName()

Return the default name for this enum instance.

Returns:

String default name

getDescription

public String getDescription()

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

Returns:

String default description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OpenMetadataTypeDefCategory>

Returns:

string description