org.unix4j.codegen.annotation

Enum InputMode

java.lang.Object

java.lang.Enum<InputMode>

org.unix4j.codegen.annotation.InputMode

All Implemented Interfaces:

Serializable, Comparable<InputMode>

public enum InputMode
extends Enum<InputMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CompleteInput The command processes its input as a whole.
LineByLine The command processes its input line by line.
NoInput The command processes no input at all.

Method Summary

Modifier and Type	Method and Description
boolean	isCompleteInput() Convenience method returning true if this constant equals CompleteInput.
boolean	isLineByLine() Convenience method returning true if this constant equals LineByLine.
boolean	isNoInput() Convenience method returning true if this constant equals NoInput.
static InputMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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

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

NoInput

public static final InputMode NoInput

The command processes no input at all. There is no obligation for the command to read the input.

Commands of this type are suitable starting points for command execution. A static method is generated in Unix4j if a command interface method is annotated with this mode.

LineByLine

public static final InputMode LineByLine

The command processes its input line by line. It is, however, a contractual obligation for the command to read the complete input passed to the execute method.

The command can process the input line-by-line and write to the output when processing a single line, but it is a requirement that all available input lines have been read when returning from the command's execute method.

CompleteInput

public static final InputMode CompleteInput

The command processes its input as a whole. It is at the same time a contractual obligation for the command to read the complete input passed to the command's execute method.

Method Detail

values

public static 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 (InputMode c : 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 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

isNoInput

public boolean isNoInput()

Convenience method returning true if this constant equals NoInput.

Returns:

true if this==NoInput

isLineByLine

public boolean isLineByLine()

Convenience method returning true if this constant equals LineByLine.

Returns:

true if this==LineByLine

isCompleteInput

public boolean isCompleteInput()

Convenience method returning true if this constant equals CompleteInput.

Returns:

true if this==CompleteInput