org.unix4j.builder

Interface To

All Known Subinterfaces:

CommandBuilder, Unix4jCommandBuilder

All Known Implementing Classes:

DefaultCommandBuilder, DefaultUnix4jCommandBuilder

public interface To

Interface defining command execution and output redirection methods.

Method Summary

Modifier and Type	Method and Description
void	toDevNull() Executes the composite command and does not write the result anywhere.
int	toExitValue() Executes the composite command returns its exit value, 0 if the command completes successfully and another command specific error value different from zero if the command throws an ExitValueException.
void	toFile(File file) Executes the composite command and writes the result to the given file.
void	toFile(String file) Executes the composite command and writes the result to the given file.
List<Line>	toLineList() Executes the composite command and returns the result as a list containing the output lines.
Stream<Line>	toLineStream() Executes the composite command and returns the result as a stream containing the output lines.
void	toOutput(Output output) Executes the composite command and writes the result to the given output.
void	toOutputStream(OutputStream stream) Executes the composite command and writes the result to the given stream.
void	toStdOut() Executes the composite command and writes the result to the standard output.
List<String>	toStringList() Executes the composite command and returns the result as a list containing the output lines without line ending.
String	toStringResult() Executes the composite command and returns the result as string.
Stream<String>	toStringStream() Executes the composite command and returns the result as a stream containing the output lines without line endings.
void	toWriter(Writer writer) Executes the composite command and writes the result using the given writer.

Method Detail

toStdOut

void toStdOut()

Executes the composite command and writes the result to the standard output.

toStringResult

String toStringResult()

Executes the composite command and returns the result as string. Line ending characters are inserted between lines if the result contains multiple lines. Note that the last line is NOT terminated with a line ending.

To return a representation of the command with its arguments without executing the command, toString() can be used instead.

Returns:

the result as a string, possibly a multiline string with newline characters between the lines but not after the last line

toLineList

List<Line> toLineList()

Executes the composite command and returns the result as a list containing the output lines.

Returns:

the result as a list of lines

toStringList

List<String> toStringList()

Executes the composite command and returns the result as a list containing the output lines without line ending.

Returns:

the result as a list of line strings

toLineStream

Stream<Line> toLineStream()

Executes the composite command and returns the result as a stream containing the output lines.

Returns:

the result as a stream of lines

toStringStream

Stream<String> toStringStream()

Executes the composite command and returns the result as a stream containing the output lines without line endings.

Returns:

the result as a stream of line strings

toFile

void toFile(String file)

Executes the composite command and writes the result to the given file.

Parameters:

file - the target output file

toDevNull

void toDevNull()

Executes the composite command and does not write the result anywhere.

toFile

void toFile(File file)

Executes the composite command and writes the result to the given file.

Parameters:

file - the target output file

toOutputStream

void toOutputStream(OutputStream stream)

Executes the composite command and writes the result to the given stream.

Parameters:

stream - the target output stream

toWriter

void toWriter(Writer writer)

Executes the composite command and writes the result using the given writer.

Parameters:

writer - the writer used to write the output

toOutput

void toOutput(Output output)

Executes the composite command and writes the result to the given output.

toExitValue

int toExitValue()

Executes the composite command returns its exit value, 0 if the command completes successfully and another command specific error value different from zero if the command throws an ExitValueException.

Returns:

the exit value returned by the command, 0 for success