Package org.odpi.openmetadata.frameworks.governanceaction.search

Enum Class PropertyCategory

java.lang.Object

java.lang.Enum<PropertyCategory>

org.odpi.openmetadata.frameworks.governanceaction.search.PropertyCategory

All Implemented Interfaces:

Serializable, Comparable<PropertyCategory>, Constable

public enum PropertyCategory
extends Enum<PropertyCategory>

The PropertyCategory defines the list of value types for the properties for open metadata. It is used in the PropertyValue 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	An ordered list of values, each with the same type.
ENUM	A pre-defined list of valid values.
MAP	A set of name->value pairs where all names are unique in the map.
PRIMITIVE	A primitive type.
STRUCT	A collection of related properties.
UNKNOWN	Uninitialized PropertyValue 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 PropertyCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PropertyCategory[]	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 PropertyCategory UNKNOWN

Uninitialized PropertyValue object.

PRIMITIVE

public static final PropertyCategory PRIMITIVE

A primitive type.

ENUM

public static final PropertyCategory ENUM

A pre-defined list of valid values.

STRUCT

public static final PropertyCategory STRUCT

A collection of related properties.

MAP

public static final PropertyCategory MAP

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

ARRAY

public static final PropertyCategory ARRAY

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

Method Details

values

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

Returns:

string description