org.eclipse.ohf.stem.definitions.labels
Enum RelativePhysicalRelationship

java.lang.Object
  extended by java.lang.Enum<RelativePhysicalRelationship>
      extended by org.eclipse.ohf.stem.definitions.labels.RelativePhysicalRelationship
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<RelativePhysicalRelationship>, org.eclipse.emf.common.util.Enumerator

public enum RelativePhysicalRelationship
extends java.lang.Enum<RelativePhysicalRelationship>
implements org.eclipse.emf.common.util.Enumerator

This class represents the enumeration of the different types of relative physical relationships.


Enum Constant Summary
ABOVE_LITERAL
          The 'Above' literal object.
BELOW_LITERAL
          The 'Below' literal object.
CONTAINED_BY_LITERAL
          The 'Contained By' literal object.
CONTAINS_LITERAL
          The 'Contains' literal object.
EAST_OF_LITERAL
          The 'East Of' literal object.
LEFT_OF_LITERAL
          The 'Left Of' literal object.
NORTH_OF_LITERAL
          The 'North Of' literal object.
ORBITS_LITERAL
          The 'Orbits' literal object.
OVERLAPS_LITERAL
          The 'Overlaps' literal object.
RIGHT_OF_LITERAL
          The 'Right Of' literal object.
SOUTH_OF_LITERAL
          The 'South Of' literal object.
UNSPECIFIED_LITERAL
          The 'Unspecified' literal object.
WEST_OF_LITERAL
          The 'West Of' literal object.
 
Field Summary
static int ABOVE
          One thing is above another, but not touching.
static int BELOW
          One thing is below another, but not touching.
static int CONTAINED_BY
          One thing is contained by another.
static int CONTAINS
          One thing completely contains another.
static java.lang.String copyright
           
static int EAST_OF
           
static int LEFT_OF
          One thing is to the left of another, but not touching.
static int NORTH_OF
          One thing is to the north of another, but not touching.
static int ORBITS
          One orbits another
static int OVERLAPS
          One thing overlaps another.
static int RIGHT_OF
          One thing is to the right of another, but not touching.
static int SOUTH_OF
          One thing is to the south of another, but not touching.
static int UNSPECIFIED
           
static java.util.List<RelativePhysicalRelationship> VALUES
          A public read-only list of all the 'Relative Physical Relationship' enumerators.
static int WEST_OF
          One thing is to the west of another, but not touching.
 
Method Summary
static RelativePhysicalRelationship get(int value)
          Returns the 'Relative Physical Relationship' literal with the specified integer value.
static RelativePhysicalRelationship get(java.lang.String literal)
          Returns the 'Relative Physical Relationship' literal with the specified literal value.
static RelativePhysicalRelationship getByName(java.lang.String name)
          Returns the 'Relative Physical Relationship' literal with the specified name.
 java.lang.String getLiteral()
           
 java.lang.String getName()
           
 int getValue()
           
 java.lang.String toString()
          Returns the literal value of the enumerator, which is its string representation.
static RelativePhysicalRelationship valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static RelativePhysicalRelationship[] values()
          Returns an array containing the constants of this enum type, in the order they're 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

UNSPECIFIED_LITERAL

public static final RelativePhysicalRelationship UNSPECIFIED_LITERAL
The 'Unspecified' literal object.

See Also:
UNSPECIFIED

ABOVE_LITERAL

public static final RelativePhysicalRelationship ABOVE_LITERAL
The 'Above' literal object.

See Also:
ABOVE

BELOW_LITERAL

public static final RelativePhysicalRelationship BELOW_LITERAL
The 'Below' literal object.

See Also:
BELOW

RIGHT_OF_LITERAL

public static final RelativePhysicalRelationship RIGHT_OF_LITERAL
The 'Right Of' literal object.

See Also:
RIGHT_OF

LEFT_OF_LITERAL

public static final RelativePhysicalRelationship LEFT_OF_LITERAL
The 'Left Of' literal object.

See Also:
LEFT_OF

NORTH_OF_LITERAL

public static final RelativePhysicalRelationship NORTH_OF_LITERAL
The 'North Of' literal object.

See Also:
NORTH_OF

SOUTH_OF_LITERAL

public static final RelativePhysicalRelationship SOUTH_OF_LITERAL
The 'South Of' literal object.

See Also:
SOUTH_OF

WEST_OF_LITERAL

public static final RelativePhysicalRelationship WEST_OF_LITERAL
The 'West Of' literal object.

See Also:
WEST_OF

EAST_OF_LITERAL

public static final RelativePhysicalRelationship EAST_OF_LITERAL
The 'East Of' literal object.

See Also:
EAST_OF

CONTAINS_LITERAL

public static final RelativePhysicalRelationship CONTAINS_LITERAL
The 'Contains' literal object.

See Also:
CONTAINS

CONTAINED_BY_LITERAL

public static final RelativePhysicalRelationship CONTAINED_BY_LITERAL
The 'Contained By' literal object.

See Also:
CONTAINED_BY

OVERLAPS_LITERAL

public static final RelativePhysicalRelationship OVERLAPS_LITERAL
The 'Overlaps' literal object.

See Also:
OVERLAPS

ORBITS_LITERAL

public static final RelativePhysicalRelationship ORBITS_LITERAL
The 'Orbits' literal object.

See Also:
ORBITS
Field Detail

copyright

public static final java.lang.String copyright

See Also:
Constant Field Values

UNSPECIFIED

public static final int UNSPECIFIED
See Also:
Constant Field Values

ABOVE

public static final int ABOVE
One thing is above another, but not touching.

See Also:
Constant Field Values

BELOW

public static final int BELOW
One thing is below another, but not touching.

See Also:
Constant Field Values

RIGHT_OF

public static final int RIGHT_OF
One thing is to the right of another, but not touching.

See Also:
Constant Field Values

LEFT_OF

public static final int LEFT_OF
One thing is to the left of another, but not touching.

See Also:
Constant Field Values

NORTH_OF

public static final int NORTH_OF
One thing is to the north of another, but not touching.

See Also:
Constant Field Values

SOUTH_OF

public static final int SOUTH_OF
One thing is to the south of another, but not touching.

See Also:
Constant Field Values

WEST_OF

public static final int WEST_OF
One thing is to the west of another, but not touching.

See Also:
Constant Field Values

EAST_OF

public static final int EAST_OF
See Also:
Constant Field Values

CONTAINS

public static final int CONTAINS
One thing completely contains another.

See Also:
Constant Field Values

CONTAINED_BY

public static final int CONTAINED_BY
One thing is contained by another.

See Also:
Constant Field Values

OVERLAPS

public static final int OVERLAPS
One thing overlaps another.

See Also:
Constant Field Values

ORBITS

public static final int ORBITS
One orbits another

See Also:
Constant Field Values

VALUES

public static final java.util.List<RelativePhysicalRelationship> VALUES
A public read-only list of all the 'Relative Physical Relationship' enumerators.

Method Detail

values

public static final RelativePhysicalRelationship[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(RelativePhysicalRelationship c : RelativePhysicalRelationship.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static RelativePhysicalRelationship valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

get

public static RelativePhysicalRelationship get(java.lang.String literal)
Returns the 'Relative Physical Relationship' literal with the specified literal value.


getByName

public static RelativePhysicalRelationship getByName(java.lang.String name)
Returns the 'Relative Physical Relationship' literal with the specified name.


get

public static RelativePhysicalRelationship get(int value)
Returns the 'Relative Physical Relationship' literal with the specified integer value.


getValue

public int getValue()

Specified by:
getValue in interface org.eclipse.emf.common.util.Enumerator

getName

public java.lang.String getName()

Specified by:
getName in interface org.eclipse.emf.common.util.Enumerator

getLiteral

public java.lang.String getLiteral()

Specified by:
getLiteral in interface org.eclipse.emf.common.util.Enumerator

toString

public java.lang.String toString()
Returns the literal value of the enumerator, which is its string representation.

Overrides:
toString in class java.lang.Enum<RelativePhysicalRelationship>