org.odpi.openmetadata.frameworks.connectors.properties.beans

Enum KeyPattern

java.lang.Object

java.lang.Enum<KeyPattern>

org.odpi.openmetadata.frameworks.connectors.properties.beans.KeyPattern

All Implemented Interfaces:

Serializable, Comparable<KeyPattern>

public enum KeyPattern
extends Enum<KeyPattern>
implements Serializable

A KeyPattern defines the type of External Identifier in use for an asset, or the type of Primary Key used within an asset.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATE_KEY
CALLERS_KEY
LOCAL_KEY
MIRROR_KEY
NATURAL_KEY
OTHER
RECYCLED_KEY
STABLE_KEY

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the default description for the key pattern 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() Standard toString method.
static KeyPattern	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyPattern[]	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

LOCAL_KEY

public static final KeyPattern LOCAL_KEY

RECYCLED_KEY

public static final KeyPattern RECYCLED_KEY

NATURAL_KEY

public static final KeyPattern NATURAL_KEY

MIRROR_KEY

public static final KeyPattern MIRROR_KEY

AGGREGATE_KEY

public static final KeyPattern AGGREGATE_KEY

CALLERS_KEY

public static final KeyPattern CALLERS_KEY

STABLE_KEY

public static final KeyPattern STABLE_KEY

OTHER

public static final KeyPattern OTHER

Method Detail

values

public static KeyPattern[] 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 (KeyPattern c : KeyPattern.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeyPattern 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 code for this enum instance

Returns:

int key pattern 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 key pattern for this enum instance.

Returns:

String default description

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<KeyPattern>

Returns:

print out of variables in a JSON-style