org.openksavi.sponge.util.process

Enum OutputRedirect

java.lang.Object

java.lang.Enum<OutputRedirect>

org.openksavi.sponge.util.process.OutputRedirect

All Implemented Interfaces:

Serializable, Comparable<OutputRedirect>

public enum OutputRedirect
extends Enum<OutputRedirect>

A subprocess output redirect type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY Writes all subprocess standard output to the ProcessInstance.getOutputBinary() byte array.
CONSUMER Sends a subprocess standard output as text lines to a line consumer (if set).
FILE Writes all subprocess standard output to the ProcessConfiguration.getOutputFile() file.
INHERIT Sets the destination for subprocess standard output to be the same as those of the current Java process.
PIPE Indicates that subprocess standard output will be connected to the current Java process over a pipe.
STRING Writes all subprocess standard output to the ProcessInstance.getOutputString() string.

Method Summary

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

PIPE

public static final OutputRedirect PIPE

Indicates that subprocess standard output will be connected to the current Java process over a pipe. This is the default handling of subprocess standard output.

INHERIT

public static final OutputRedirect INHERIT

Sets the destination for subprocess standard output to be the same as those of the current Java process.

STRING

public static final OutputRedirect STRING

Writes all subprocess standard output to the ProcessInstance.getOutputString() string. The thread that started the subprocess will wait for the subprocess to exit.

BINARY

public static final OutputRedirect BINARY

Writes all subprocess standard output to the ProcessInstance.getOutputBinary() byte array. The thread that started the subprocess will wait for the subprocess to exit.

FILE

public static final OutputRedirect FILE

Writes all subprocess standard output to the ProcessConfiguration.getOutputFile() file. The thread that started the subprocess will wait for the subprocess to exit.

CONSUMER

public static final OutputRedirect CONSUMER

Sends a subprocess standard output as text lines to a line consumer (if set). It also logs the subprocess standard output to the logger (as INFO).

Method Detail

values

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

Returns:

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

valueOf

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