org.plasma.sdo.profile

Enum KeyType

java.lang.Object

java.lang.Enum<KeyType>

org.plasma.sdo.profile.KeyType

All Implemented Interfaces:

Serializable, Comparable<KeyType>

public enum KeyType
extends Enum<KeyType>

This enumeration specifies the set of key types possible for any UML Property tagged with the SDOKey stereotype.

Version:

1.3.2

Author:

Plasma-Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
external Tags a property as a key used as an external identifier for a Class.
internal Tags a property as a key used as an internal identifier for a Class
primary A key used as a primary identifier for the UML Class of the UML Property tagged with the SDOKey stereotype.

Method Summary

Modifier and Type	Method and Description
static KeyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeyType[]	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

primary

public static final KeyType primary

A key used as a primary identifier for the UML Class of the UML Property tagged with the SDOKey stereotype.

internal

public static final KeyType internal

Tags a property as a key used as an internal identifier for a Class

external

public static final KeyType external

Tags a property as a key used as an external identifier for a Class. An external identifier may be used by external systems and processes to uniquely idendify an object within the source system without significant central coordination. An external key is typically a universally unique identifier (UUID), globally unique identifier (GUID) or variant

Method Detail

values

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

Returns:

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

valueOf

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