org.eclipse.jpt.jpa.eclipselink.core.resource.orm
Enum XmlDirection

java.lang.Object
  extended by java.lang.Enum<XmlDirection>
      extended by org.eclipse.jpt.jpa.eclipselink.core.resource.orm.XmlDirection
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<XmlDirection>, org.eclipse.emf.common.util.Enumerator

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

A representation of the literals of the enumeration 'Xml Direction', and utility methods for working with them. Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:
2.2
Version:
2.2
See Also:
EclipseLinkOrmPackage.getXmlDirection()

Enum Constant Summary
IN
          The 'IN' literal object.
IN_OUT
          The 'IN OUT' literal object.
OUT
          The 'OUT' literal object.
OUT_CURSOR
          The 'OUT CURSOR' literal object.
 
Field Summary
static int IN_OUT_VALUE
          The 'IN OUT' literal value.
static int IN_VALUE
          The 'IN' literal value.
static int OUT_CURSOR_VALUE
          The 'OUT CURSOR' literal value.
static int OUT_VALUE
          The 'OUT' literal value.
static java.util.List<XmlDirection> VALUES
          A public read-only list of all the 'Xml Direction' enumerators.
 
Method Summary
static XmlDirection get(int value)
          Returns the 'Xml Direction' literal with the specified integer value.
static XmlDirection get(java.lang.String literal)
          Returns the 'Xml Direction' literal with the specified literal value.
static XmlDirection getByName(java.lang.String name)
          Returns the 'Xml Direction' 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 XmlDirection valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static XmlDirection[] 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

IN

public static final XmlDirection IN
The 'IN' literal object.

See Also:
IN_VALUE

OUT

public static final XmlDirection OUT
The 'OUT' literal object.

See Also:
OUT_VALUE

IN_OUT

public static final XmlDirection IN_OUT
The 'IN OUT' literal object.

See Also:
IN_OUT_VALUE

OUT_CURSOR

public static final XmlDirection OUT_CURSOR
The 'OUT CURSOR' literal object.

See Also:
OUT_CURSOR_VALUE
Field Detail

IN_VALUE

public static final int IN_VALUE
The 'IN' literal value.

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

See Also:
IN, Constant Field Values

OUT_VALUE

public static final int OUT_VALUE
The 'OUT' literal value.

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

See Also:
OUT, Constant Field Values

IN_OUT_VALUE

public static final int IN_OUT_VALUE
The 'IN OUT' literal value.

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

See Also:
IN_OUT, Constant Field Values

OUT_CURSOR_VALUE

public static final int OUT_CURSOR_VALUE
The 'OUT CURSOR' literal value.

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

See Also:
OUT_CURSOR, Constant Field Values

VALUES

public static final java.util.List<XmlDirection> VALUES
A public read-only list of all the 'Xml Direction' enumerators.

Method Detail

values

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

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

valueOf

public static XmlDirection 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
java.lang.NullPointerException - if the argument is null

get

public static XmlDirection get(java.lang.String literal)
Returns the 'Xml Direction' literal with the specified literal value.


getByName

public static XmlDirection getByName(java.lang.String name)
Returns the 'Xml Direction' literal with the specified name.


get

public static XmlDirection get(int value)
Returns the 'Xml Direction' 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<XmlDirection>