org.plasma.provisioning.rdb.mysql.v5_5

Enum ColumnKeyType

java.lang.Object

java.lang.Enum<ColumnKeyType>

org.plasma.provisioning.rdb.mysql.v5_5.ColumnKeyType

All Implemented Interfaces:

Serializable, Comparable<ColumnKeyType>, PlasmaEnum

public enum ColumnKeyType
extends Enum<ColumnKeyType>
implements PlasmaEnum

This generated Enumeration represents the domain model enumeration ColumnKeyType which is part of namespace http://org.plasma/sdo/mysql/5_5 as defined within the Configuration.

* Generated SDO enumerations embody not only logical-name literals but also physical or instance names, which are often shorter (possibly abbreviated) and applicable as a data-store space-saving device. Application programs should typically use the physical or instance name for an enumeration literal when setting a data object property which is constrained by an enumeration.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MUL Holds the logical and physical names for literal MUL.
PRI Holds the logical and physical names for literal PRI.
UNI Holds the logical and physical names for literal UNI.

Method Summary

Modifier and Type	Method and Description
static PlasmaEnum[]	enumValues() Returns the enum values for this class as an array of implemented interfaces
static ColumnKeyType	fromInstanceName(String instanceName) Returns the enumeration value matching the given physical or instance name.
static ColumnKeyType	fromName(String name) Returns the enumeration value matching the given name.
String	getDescription() Returns the descriptive text associated with this enumeration literal.
String	getInstanceName() Returns the physical or instance name associated with this enumeration literal.
String	getName() Returns the logical name associated with this enumeration literal.
static ColumnKeyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ColumnKeyType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRI

public static final ColumnKeyType PRI

Holds the logical and physical names for literal PRI.

UNI

public static final ColumnKeyType UNI

Holds the logical and physical names for literal UNI.

MUL

public static final ColumnKeyType MUL

Holds the logical and physical names for literal MUL.

Method Detail

values

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

Returns:

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

valueOf

public static ColumnKeyType 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

getName

public String getName()

Returns the logical name associated with this enumeration literal.

Specified by:

getName in interface PlasmaEnum

getInstanceName

public String getInstanceName()

Returns the physical or instance name associated with this enumeration literal.

Specified by:

getInstanceName in interface PlasmaEnum

getDescription

public String getDescription()

Returns the descriptive text associated with this enumeration literal.

Specified by:

getDescription in interface PlasmaEnum

enumValues

public static PlasmaEnum[] enumValues()

Returns the enum values for this class as an array of implemented interfaces

See Also:

PlasmaEnum

fromName

public static ColumnKeyType fromName(String name)

Returns the enumeration value matching the given name.

fromInstanceName

public static ColumnKeyType fromInstanceName(String instanceName)

Returns the enumeration value matching the given physical or instance name.