Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs

Enum Class TypeDefCategory

java.lang.Object

java.lang.Enum<TypeDefCategory>

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory

All Implemented Interfaces:

Serializable, Comparable<TypeDefCategory>, Constable

public enum TypeDefCategory
extends Enum<TypeDefCategory>
implements Serializable

The TypeDefCategory defines the list of valid types of TypeDef 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	ClassificationDef - A description of a specific characteristic or grouping for entities.
ENTITY_DEF	EntityDef - An object or concept of interest.
RELATIONSHIP_DEF	RelationshipDef - A link between two entities.
UNKNOWN_DEF	Unknown - Uninitialized TypeDef 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 TypeDefCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TypeDefCategory[]	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 TypeDefCategory UNKNOWN_DEF

Unknown - Uninitialized TypeDef object.

CLASSIFICATION_DEF

public static final TypeDefCategory CLASSIFICATION_DEF

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

ENTITY_DEF

public static final TypeDefCategory ENTITY_DEF

EntityDef - An object or concept of interest.

RELATIONSHIP_DEF

public static final TypeDefCategory RELATIONSHIP_DEF

RelationshipDef - A link between two entities.

Method Details

values

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

Returns:

string description