org.eclipse.ocl.pivot

Enum CollectionKind

java.lang.Object

java.lang.Enum<CollectionKind>

org.eclipse.ocl.pivot.CollectionKind

All Implemented Interfaces:

Serializable, Comparable<CollectionKind>

public enum CollectionKind
extends Enum<CollectionKind>

A representation of the literals of the enumeration 'Collection Kind', and utility methods for working with them.

See Also:

PivotPackage.getCollectionKind()

EMF generated code

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAG The 'Bag' literal object.
COLLECTION The 'Collection' literal object.
ORDERED_SET The 'Ordered Set' literal object.
SEQUENCE The 'Sequence' literal object.
SET The 'Set' literal object.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BAG_VALUE The 'Bag' literal value.
static int	COLLECTION_VALUE The 'Collection' literal value.
static int	ORDERED_SET_VALUE The 'Ordered Set' literal value.
static int	SEQUENCE_VALUE The 'Sequence' literal value.
static int	SET_VALUE The 'Set' literal value.
static List<CollectionKind>	VALUES A public read-only list of all the 'Collection Kind' enumerators.

Method Summary

Modifier and Type	Method and Description
static CollectionKind	get(int value) Returns the 'Collection Kind' literal with the specified integer value.
static CollectionKind	get(String literal) Returns the 'Collection Kind' literal with the specified literal value.
static CollectionKind	getByName(String name) Returns the 'Collection Kind' literal with the specified name.
String	getLiteral()
String	getName()
int	getValue()
String	toString() Returns the literal value of the enumerator, which is its string representation.
static CollectionKind	valueOf(String name) Returns the enum constant of this type with the specified name.
static CollectionKind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COLLECTION

public static final CollectionKind COLLECTION

The 'Collection' literal object.

See Also:

COLLECTION_VALUE

EMF generated code

Ordered

SET

public static final CollectionKind SET

The 'Set' literal object.

See Also:

SET_VALUE

EMF generated code

Ordered

ORDERED_SET

public static final CollectionKind ORDERED_SET

The 'Ordered Set' literal object.

See Also:

ORDERED_SET_VALUE

EMF generated code

Ordered

BAG

public static final CollectionKind BAG

The 'Bag' literal object.

See Also:

BAG_VALUE

EMF generated code

Ordered

SEQUENCE

public static final CollectionKind SEQUENCE

The 'Sequence' literal object.

See Also:

SEQUENCE_VALUE

EMF generated code

Ordered

Field Detail

COLLECTION_VALUE

public static final int COLLECTION_VALUE

The 'Collection' literal value.

If the meaning of 'Collection' literal object isn't clear, there really should be more of a description here...

See Also:

COLLECTION, Constant Field Values

EMF generated code

Ordered

SET_VALUE

public static final int SET_VALUE

The 'Set' literal value.

If the meaning of 'Set' literal object isn't clear, there really should be more of a description here...

See Also:

SET, Constant Field Values

EMF generated code

Ordered

ORDERED_SET_VALUE

public static final int ORDERED_SET_VALUE

The 'Ordered Set' literal value.

If the meaning of 'Ordered Set' literal object isn't clear, there really should be more of a description here...

See Also:

ORDERED_SET, Constant Field Values

EMF generated code

Ordered

BAG_VALUE

public static final int BAG_VALUE

The 'Bag' literal value.

If the meaning of 'Bag' literal object isn't clear, there really should be more of a description here...

See Also:

BAG, Constant Field Values

EMF generated code

Ordered

SEQUENCE_VALUE

public static final int SEQUENCE_VALUE

The 'Sequence' literal value.

If the meaning of 'Sequence' literal object isn't clear, there really should be more of a description here...

See Also:

SEQUENCE, Constant Field Values

EMF generated code

Ordered

VALUES

public static final List<CollectionKind> VALUES

A public read-only list of all the 'Collection Kind' enumerators.

EMF generated code

Method Detail

values

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

Returns:

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

valueOf

public static CollectionKind 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 CollectionKind get(String literal)

Returns the 'Collection Kind' literal with the specified literal value.

Parameters:

literal - the literal.

Returns:

the matching enumerator or null.

EMF generated code

getByName

public static CollectionKind getByName(String name)

Returns the 'Collection Kind' literal with the specified name.

Parameters:

name - the name.

Returns:

the matching enumerator or null.

EMF generated code

get

public static CollectionKind get(int value)

Returns the 'Collection Kind' literal with the specified integer value.

Parameters:

value - the integer value.

Returns:

the matching enumerator or null.

EMF generated code

getValue

public int getValue()

EMF generated code

getName

public String getName()

EMF generated code

getLiteral

public String getLiteral()

EMF generated code

toString

public String toString()

Returns the literal value of the enumerator, which is its string representation.

Overrides:

toString in class Enum<CollectionKind>

EMF generated code