/*******************************************************************************
* Copyright (c) 2006, 2008 IBM Corporation, Zeligsoft Inc., and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM - Initial API and implementation
* Zeligsoft - Bug 207365
*******************************************************************************/
package org.eclipse.ocl.expressions;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import org.eclipse.emf.common.util.Enumerator;
/**
* <!-- begin-user-doc -->
* A representation of the literals of the enumeration '<em><b>Collection Kind</b></em>',
* and utility methods for working with them.
* <!-- end-user-doc -->
* @see org.eclipse.ocl.expressions.ExpressionsPackage#getCollectionKind()
* @model
* @generated
*/
public enum CollectionKind
implements Enumerator {
//$NON-NLS-1$ //$NON-NLS-2$
/**
* The '<em><b>Set</b></em>' literal object.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #SET
* @generated
* @ordered
*/
SET_LITERAL(0, "Set", "Set"), //$NON-NLS-1$ //$NON-NLS-2$
/**
* The '<em><b>Ordered Set</b></em>' literal object.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #ORDERED_SET
* @generated
* @ordered
*/
ORDERED_SET_LITERAL(1, "OrderedSet", "OrderedSet"), //$NON-NLS-1$ //$NON-NLS-2$
/**
* The '<em><b>Bag</b></em>' literal object.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #BAG
* @generated
* @ordered
*/
BAG_LITERAL(2, "Bag", "Bag"), //$NON-NLS-1$ //$NON-NLS-2$
/**
* The '<em><b>Sequence</b></em>' literal object.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #SEQUENCE
* @generated
* @ordered
*/
SEQUENCE_LITERAL(3, "Sequence", "Sequence"), //$NON-NLS-1$ //$NON-NLS-2$
/**
* The '<em><b>Collection</b></em>' literal object.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #COLLECTION
* @generated
* @ordered
*/
COLLECTION_LITERAL(4, "Collection", "Collection"); //$NON-NLS-1$ //$NON-NLS-2$
/**
* The '<em><b>Set</b></em>' literal value.
* <!-- begin-user-doc -->
* <p>
* If the meaning of '<em><b>Set</b></em>' literal object isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @see #SET_LITERAL
* @model name="Set"
* @generated
* @ordered
*/
public static final int SET = 0;
/**
* The '<em><b>Ordered Set</b></em>' literal value.
* <!-- begin-user-doc -->
* <p>
* If the meaning of '<em><b>Ordered Set</b></em>' literal object isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @see #ORDERED_SET_LITERAL
* @model name="OrderedSet"
* @generated
* @ordered
*/
public static final int ORDERED_SET = 1;
/**
* The '<em><b>Bag</b></em>' literal value.
* <!-- begin-user-doc -->
* <p>
* If the meaning of '<em><b>Bag</b></em>' literal object isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @see #BAG_LITERAL
* @model name="Bag"
* @generated
* @ordered
*/
public static final int BAG = 2;
/**
* The '<em><b>Sequence</b></em>' literal value.
* <!-- begin-user-doc -->
* <p>
* If the meaning of '<em><b>Sequence</b></em>' literal object isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @see #SEQUENCE_LITERAL
* @model name="Sequence"
* @generated
* @ordered
*/
public static final int SEQUENCE = 3;
/**
* The '<em><b>Collection</b></em>' literal value.
* <!-- begin-user-doc -->
* <p>
* If the meaning of '<em><b>Collection</b></em>' literal object isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @see #COLLECTION_LITERAL
* @model name="Collection"
* @generated
* @ordered
*/
public static final int COLLECTION = 4;
/**
* An array of all the '<em><b>Collection Kind</b></em>' enumerators.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
private static final CollectionKind[] VALUES_ARRAY = new CollectionKind[]{
SET_LITERAL, ORDERED_SET_LITERAL, BAG_LITERAL, SEQUENCE_LITERAL,
COLLECTION_LITERAL,};
/**
* A public read-only list of all the '<em><b>Collection Kind</b></em>' enumerators.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
public static final List<CollectionKind> VALUES = Collections
.unmodifiableList(Arrays.asList(VALUES_ARRAY));
/**
* Returns the '<em><b>Collection Kind</b></em>' literal with the specified literal value.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param literal the literal.
* @return the matching enumerator or <code>null</code>.
* @generated
*/
public static CollectionKind get(String literal) {
for (int i = 0; i < VALUES_ARRAY.length; ++i) {
CollectionKind result = VALUES_ARRAY[i];
if (result.toString().equals(literal)) {
return result;
}
}
return null;
}
/**
* Returns the '<em><b>Collection Kind</b></em>' literal with the specified name.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param name the name.
* @return the matching enumerator or <code>null</code>.
* @generated
*/
public static CollectionKind getByName(String name) {
for (int i = 0; i < VALUES_ARRAY.length; ++i) {
CollectionKind result = VALUES_ARRAY[i];
if (result.getName().equals(name)) {
return result;
}
}
return null;
}
/**
* Returns the '<em><b>Collection Kind</b></em>' literal with the specified integer value.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the integer value.
* @return the matching enumerator or <code>null</code>.
* @generated
*/
public static CollectionKind get(int value) {
switch (value) {
case SET :
return SET_LITERAL;
case ORDERED_SET :
return ORDERED_SET_LITERAL;
case BAG :
return BAG_LITERAL;
case SEQUENCE :
return SEQUENCE_LITERAL;
case COLLECTION :
return COLLECTION_LITERAL;
}
return null;
}
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
private final int value;
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
private final String name;
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
private final String literal;
/**
* Only this class can construct instances.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
private CollectionKind(int value, String name, String literal) {
this.value = value;
this.name = name;
this.literal = literal;
}
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
public int getValue() {
return value;
}
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
public String getName() {
return name;
}
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
public String getLiteral() {
return literal;
}
/**
* Returns the literal value of the enumerator, which is its string representation.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @generated
*/
@Override
public String toString() {
return literal;
}
public static CollectionKind getKind(boolean ordered, boolean unique) {
if (ordered) {
return unique
? ORDERED_SET_LITERAL
: SEQUENCE_LITERAL;
} else {
return unique
? SET_LITERAL
: BAG_LITERAL;
}
}
} //CollectionKind