org.jooq.util
Enum InOutDefinition

java.lang.Object
  java.lang.Enum<InOutDefinition>
      org.jooq.util.InOutDefinition

All Implemented Interfaces:

Serializable, Comparable<InOutDefinition>

public enum InOutDefinition
extends Enum<InOutDefinition>

The parameter type of a stored procedure

Author:

Lukas Eder

Enum Constant Summary

IN
An in parameter.

INOUT
An in/out parameter

OUT
An out parameter

RETURN
A return value for a function

Method Summary

static InOutDefinition	getFromString(String string) Convert a string into the corresponding InOutDefinition value.
static InOutDefinition	valueOf(String name) Returns the enum constant of this type with the specified name.
static InOutDefinition[]	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 InOutDefinition IN

An in parameter. Default if the in/out keyword is absent.

OUT

public static final InOutDefinition OUT

An out parameter

INOUT

public static final InOutDefinition INOUT

An in/out parameter

RETURN

public static final InOutDefinition RETURN

A return value for a function

Method Detail

values

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

Returns:

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

valueOf

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

getFromString

public static final InOutDefinition getFromString(String string)

Convert a string into the corresponding InOutDefinition value.

Parameters:

string - IN, OUT, INOUT or null

Returns:

The in/out value