com.goldencode.p2j.util

Enum ParameterOption

java.lang.Object

java.lang.Enum<ParameterOption>

com.goldencode.p2j.util.ParameterOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ParameterOption>

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

This enum declares the parameter passing options for complex data structures (TABLE, DATASET, TABLE-HANDLE and DATASET-HANDLE for both parameter declaration and parameter passing. The enum is used in both DataSetParameter and TableParameter as an optional parameter in the constructor.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPEND Data is appended instead of being referenced or replaced.
BIND The structure is bound (see BIND mode).
BY_REFERENCE The structure is passed by reference (see BY-REFERENCE mode).
BY_VALUE The structure is passed by value (see BY-VALUE mode).
NONE No option specified.

Method Summary

Modifier and Type	Method and Description
static ParameterOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ParameterOption[]	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

NONE

public static final ParameterOption NONE

No option specified. Use the default. This is not actually emitted in generated code, only used at runtime to initialize the internal data.

APPEND

public static final ParameterOption APPEND

Data is appended instead of being referenced or replaced.

BY_REFERENCE

public static final ParameterOption BY_REFERENCE

The structure is passed by reference (see BY-REFERENCE mode).

BIND

public static final ParameterOption BIND

The structure is bound (see BIND mode).

BY_VALUE

public static final ParameterOption BY_VALUE

The structure is passed by value (see BY-VALUE mode).

Method Detail

values

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

Returns:

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

valueOf

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