com.github.dm.jrt.annotation

Enum Output.OutputMode

java.lang.Object

java.lang.Enum<Output.OutputMode>

com.github.dm.jrt.annotation.Output.OutputMode

All Implemented Interfaces:

Serializable, Comparable<Output.OutputMode>

Enclosing class:

Output

public static enum Output.OutputMode
extends Enum<Output.OutputMode>

Output transfer mode type.
The mode indicates in which way the result is passed outside.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL Channel mode. The variable is just passed to an output channel.
COLLECTION Collection mode. The results are collected before being returned by the annotated method.
ELEMENT Element mode. The elements of the result array or iterable are passed one by one to the output channel.

Method Summary

Methods

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

Channel mode.
The variable is just passed to an output channel.

The annotated method must return a superclass of OutputChannel.

ELEMENT

public static final Output.OutputMode ELEMENT

Element mode.
The elements of the result array or iterable are passed one by one to the output channel.

The annotated method must return a superclass of OutputChannel.

COLLECTION

public static final Output.OutputMode COLLECTION

Collection mode.
The results are collected before being returned by the annotated method.

The annotated method must return an array or a superclass of List.

Method Detail

values

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

Returns:

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

valueOf

public static Output.OutputMode 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