com.palantir.giraffe.command

Class CommandContext.Builder

java.lang.Object

com.palantir.giraffe.command.CommandContext.Builder

Enclosing class:

CommandContext

public static final class CommandContext.Builder
extends Object

Builds CommandContext objects.

Method Summary

Modifier and Type	Method and Description
CommandContext	build() Creates a new CommandContext using the settings configured by this builder.
CommandContext.Builder	discardOutput() Discards all output from commands.
CommandContext.Builder	environment(CommandEnvironment environment) Sets the environment for commands executed with this context.
CommandContext.Builder	ignoreExitStatus() Allows any exit status for commands executed with this context.
CommandContext.Builder	outputWindowSizes(int stdoutWindow, int stderrWindow) Sets the window sizes for the process output streams.
CommandContext.Builder	requireExitStatus(int status) Sets the required exit status for commands executed with this context.
CommandContext.Builder	requireExitStatus(Predicate<Integer> exitStatusVerifier) Indicates what the permissible exit status of a command execution is through a Predicate.
CommandContext.Builder	workingDirectory(Path path) Sets the working directory for commands executed with this context.
CommandContext.Builder	workingDirectory(UniformPath path) Sets the working directory for commands executed with this context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

environment

public CommandContext.Builder environment(CommandEnvironment environment)

Sets the environment for commands executed with this context.

Parameters:

environment - the environment

Returns:

this builder

requireExitStatus

public CommandContext.Builder requireExitStatus(int status)

Sets the required exit status for commands executed with this context. If the command exits with a different exit status, a CommandException is thrown.

By default, an exit status of 0 is required.

Parameters:

status - the required exit status

Returns:

this builder

ignoreExitStatus

public CommandContext.Builder ignoreExitStatus()

Allows any exit status for commands executed with this context. When this is set, CommandException is never thrown.

Returns:

this builder

requireExitStatus

public CommandContext.Builder requireExitStatus(Predicate<Integer> exitStatusVerifier)

Indicates what the permissible exit status of a command execution is through a Predicate. If the Predicate returns true, that is implied to mean that the exit status is permissible.

Parameters:

exitStatusVerifier - The Predicate used to verify the exit status

Returns:

this builder

workingDirectory

public CommandContext.Builder workingDirectory(UniformPath path)

Sets the working directory for commands executed with this context.

Parameters:

path - the working directory path

Returns:

this builder

workingDirectory

public CommandContext.Builder workingDirectory(Path path)

Sets the working directory for commands executed with this context.

This method is equivalent to calling workingDirectory(UniformPath) after converting the path to a UniformPath.

Parameters:

path - the working directory path

Returns:

this builder

See Also:

UniformPath.fromPath(Path)

discardOutput

public CommandContext.Builder discardOutput()

Discards all output from commands. Equivalent to outputWindowSizes(0, 0).

Returns:

this builder

outputWindowSizes

public CommandContext.Builder outputWindowSizes(int stdoutWindow,
                                                int stderrWindow)

Sets the window sizes for the process output streams.

The size of the window determines the amount of recent output buffered for reading. If data is written beyond the window size without corresponding reads, data older than the window is discarded. A window size of 0 discards all data.

By default, there is no window and buffering is limited by the maximum size of the buffer array (effectively a window of size Integer.MAX_VALUE).

Parameters:

stdoutWindow - the window for the output stream

stderrWindow - the window for the error stream

Returns:

this builder

build

public CommandContext build()

Creates a new CommandContext using the settings configured by this builder. The builder may be reused to create more contexts after calling this method.