com.github.dm.jrt.annotation

Enum Input.InputMode

java.lang.Object

java.lang.Enum<Input.InputMode>

com.github.dm.jrt.annotation.Input.InputMode

All Implemented Interfaces:

Serializable, Comparable<Input.InputMode>

Enclosing class:

Input

public static enum Input.InputMode
extends Enum<Input.InputMode>

Input transfer mode type.
The mode indicates in which way a parameter is passed to the wrapped method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL Channel mode. The variable is just read from an output channel.
COLLECTION Collection mode. The inputs are collected from the channel and passed as an array or collection to the wrapped method.
ELEMENT Element mode. Each element of the input collection or array is passed separately to the wrapped method.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHANNEL

public static final Input.InputMode CHANNEL

Channel mode.
The variable is just read from an output channel.

The annotated parameters must extend an OutputChannel.

ELEMENT

public static final Input.InputMode ELEMENT

Element mode.
Each element of the input collection or array is passed separately to the wrapped method.

The annotated parameter must be an array or implement an Iterable and must be the only parameter accepted by the method.

COLLECTION

public static final Input.InputMode COLLECTION

Collection mode.
The inputs are collected from the channel and passed as an array or collection to the wrapped method.

The annotated parameter must extend an OutputChannel and must be the only parameter accepted by the method.

Method Detail

values

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

Returns:

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

valueOf

public static Input.InputMode 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