xdev.vt

Enum Cardinality

java.lang.Object

java.lang.Enum<Cardinality>

xdev.vt.Cardinality

All Implemented Interfaces:

Serializable, Comparable<Cardinality>

public enum Cardinality
extends Enum<Cardinality>

An enum specifying the possible cardinalities for entities within a EntityRelationship.

Author:

TF

See Also:

EntityRelationship, EntityRelationship.Entity

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANY The entities on the other side of the relation may reference 0 to many entites with this Cardinality.
ONE The entities on the other side of the relation can reference at most one entity with this Cardinality.

Method Summary

Modifier and Type	Method and Description
static Cardinality	get(String shortcut) Returns the enum value for a specified shortcut.
String	getShortcut() Returns the shortcut for this enum value.
String	toString() Returns a string representation of this enum value, consisting of the shortcut.
static Cardinality	valueOf(String name) Returns the enum constant of this type with the specified name.
static Cardinality[]	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

ONE

public static final Cardinality ONE

The entities on the other side of the relation can reference at most one entity with this Cardinality.

MANY

public static final Cardinality MANY

The entities on the other side of the relation may reference 0 to many entites with this Cardinality.

Method Detail

values

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

Returns:

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

valueOf

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

get

public static Cardinality get(String shortcut)

Returns the enum value for a specified shortcut.

Parameters:

shortcut - a valid shortcurt for a Cardinality value.

Returns:

a Cardinality

Throws:

IllegalArgumentException - if an invalid shortcut was used.

getShortcut

public String getShortcut()

Returns the shortcut for this enum value.

Returns:

the shortcut

toString

public String toString()

Returns a string representation of this enum value, consisting of the shortcut.

Overrides:

toString in class Enum<Cardinality>

Returns:

the shortcut