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

Enum Class InstancePropertyCategory

java.lang.Object

java.lang.Enum<InstancePropertyCategory>

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstancePropertyCategory

All Implemented Interfaces:

Serializable, Comparable<InstancePropertyCategory>, Constable

public enum InstancePropertyCategory
extends Enum<InstancePropertyCategory>
implements Serializable

The InstancePropertyCategory defines the list of value types for the properties for open metadata. It is used in the InstancePropertyValue class to distinguish its subclasses.

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
ARRAY	Array - An ordered list of values, each with the same type.
ENUM	Enum - A pre-defined list of valid values.
MAP	Map - A set of name->value pairs where all names are unique in the map.
PRIMITIVE	Primitive - A primitive type.
STRUCT	Struct - A collection of related properties.
UNKNOWN	Unknown - Uninitialized InstancePropertyValue 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 InstancePropertyCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InstancePropertyCategory[]	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

public static final InstancePropertyCategory UNKNOWN

Unknown - Uninitialized InstancePropertyValue object.

PRIMITIVE

public static final InstancePropertyCategory PRIMITIVE

Primitive - A primitive type.

ENUM

public static final InstancePropertyCategory ENUM

Enum - A pre-defined list of valid values.

STRUCT

public static final InstancePropertyCategory STRUCT

Struct - A collection of related properties.

MAP

public static final InstancePropertyCategory MAP

Map - A set of name->value pairs where all names are unique in the map.

ARRAY

public static final InstancePropertyCategory ARRAY

Array - An ordered list of values, each with the same type.

Method Details

values

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

Returns:

string description