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

Enum CollectionDefCategory

java.lang.Object

java.lang.Enum<CollectionDefCategory>

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

All Implemented Interfaces:

Serializable, Comparable<CollectionDefCategory>

public enum CollectionDefCategory
extends Enum<CollectionDefCategory>
implements Serializable

This enum defines the list of open metadata collection types. These types are generic types that need to be configured with specific primitive types before they can be used as an attribute type. The enum includes a code value, a string name for the type (used in self describing structures such as JSON or XML) and the name of the Java Class that supports this type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OM_COLLECTION_ARRAY
OM_COLLECTION_MAP
OM_COLLECTION_STRUCT
OM_COLLECTION_UNKNOWN

Method Summary

Modifier and Type	Method and Description
int	getArgumentCount() Return the number of arguments for this collection type.
String	getJavaClassName() Return the name of the java class that can be used to store properties of this type.
String	getName() Return the name of type that can be used for text-based interchange formats such as JSON or XML.
int	getOrdinal() Return the numeric code for the primitive type which can be used in optimized data flows.
String	toString() toString() JSON-style
static CollectionDefCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static CollectionDefCategory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OM_COLLECTION_UNKNOWN

public static final CollectionDefCategory OM_COLLECTION_UNKNOWN

OM_COLLECTION_MAP

public static final CollectionDefCategory OM_COLLECTION_MAP

OM_COLLECTION_ARRAY

public static final CollectionDefCategory OM_COLLECTION_ARRAY

OM_COLLECTION_STRUCT

public static final CollectionDefCategory OM_COLLECTION_STRUCT

Method Detail

values

public static CollectionDefCategory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CollectionDefCategory c : CollectionDefCategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CollectionDefCategory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the numeric code for the primitive type which can be used in optimized data flows.

Returns:

int type code

getName

public String getName()

Return the name of type that can be used for text-based interchange formats such as JSON or XML.

Returns:

String type name

getArgumentCount

public int getArgumentCount()

Return the number of arguments for this collection type.

Returns:

int number of elements

getJavaClassName

public String getJavaClassName()

Return the name of the java class that can be used to store properties of this type.

Returns:

String java class name.

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<CollectionDefCategory>

Returns:

string description