EclipseLink 1.2.0, build 'v20091016-r5565' API Reference

org.eclipse.persistence.annotations
Enum Direction

java.lang.Object
  extended by java.lang.Enum<Direction>
      extended by org.eclipse.persistence.annotations.Direction
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Direction>

public enum Direction
extends java.lang.Enum<Direction>

An enum that is used within the StoredProcedureParameter annotation. It is used to specify the direction of the stored procedure parameters of a named stored procedure query.

See Also:
StoredProcedureParameter
Author:
Guy Pelletier
Since:
Oracle TopLink 11.1.1.0.0

Enum Constant Summary
IN
          Input parameter
IN_OUT
          Input and output parameter
OUT
          Output parameter
OUT_CURSOR
          Output cursor
 
Method Summary
static Direction valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Direction[] 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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

IN

public static final Direction IN
Input parameter


OUT

public static final Direction OUT
Output parameter


IN_OUT

public static final Direction IN_OUT
Input and output parameter


OUT_CURSOR

public static final Direction OUT_CURSOR
Output cursor

Method Detail

values

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

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

valueOf

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

EclipseLink 1.2.0, build 'v20091016-r5565' API Reference