CommandContext (Giraffe 0.8.0)

java.lang.Object
- com.palantir.giraffe.command.CommandContext

```
public final class CommandContext
extends Object
```
Provides command-independent information that influences how commands execute. For example, the context controls the working directory in which commands execute and the values of environment variables.
This class provides several static factory methods for creating common contexts. For more complex contexts that set multiple properties, use the builder.
Instances of this class are immutable.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CommandContext.Builder
Builds CommandContext objects.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CommandContext.Builder` Builds `CommandContext` objects.

Method Summary

Methods
Modifier and Type	Method and Description
`static CommandContext.Builder`	`builder()` Returns a new `CommandContext` builder.
`static CommandContext`	`defaultContext()` Returns the default context object.
`CommandEnvironment`	`getEnvironment()` Returns a copy of this context's `CommandEnvironment`.
`Predicate<Integer>`	`getExitStatusVerifier()` Returns the predicate this context uses to verify the exit status of commands.
`Optional<Integer>`	`getStderrWindowSize()` Returns this context's error window.
`Optional<Integer>`	`getStdoutWindowSize()` Returns this context's output window.
`Optional<UniformPath>`	`getWorkingDirectory()` Returns this context's working directory.
`static CommandContext`	`ignoreExitStatus()` Returns a context that ignores the exit status of commands.
`static CommandContext`	`requireExitStatus(int status)` Returns a context that requires commands exit with the given status.
`static CommandContext`	`withEnvironment(CommandEnvironment environment)` Returns a context that sets the given environment before commands execute.
`static CommandContext`	`workingDirectory(Path path)` Returns a context that executes commands in the given directory.
`static CommandContext`	`workingDirectory(UniformPath path)` Returns a context that executes commands in the given directory.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static CommandContext.Builder builder()
```
    Returns a new CommandContext builder.
  - defaultContext
```
public static CommandContext defaultContext()
```
    Returns the default context object. The default context uses the default environment, the default working directory, and requires that commands exit with status 0.
  - ignoreExitStatus
```
public static CommandContext ignoreExitStatus()
```
    Returns a context that ignores the exit status of commands.
    
    See Also:
    CommandContext.Builder.ignoreExitStatus()
  - requireExitStatus
```
public static CommandContext requireExitStatus(int status)
```
    Returns a context that requires commands exit with the given status.
    
    Parameters:
    status - the required exit status
    See Also:
    CommandContext.Builder.requireExitStatus(int)
  - withEnvironment
```
public static CommandContext withEnvironment(CommandEnvironment environment)
```
    Returns a context that sets the given environment before commands execute.
    
    Parameters:
    environment - the environment
    See Also:
    CommandContext.Builder.environment(CommandEnvironment)
  - workingDirectory
```
public static CommandContext workingDirectory(UniformPath path)
```
    Returns a context that executes commands in the given directory.
    
    Parameters:
    path - the working directory path
    See Also:
    CommandContext.Builder.workingDirectory(UniformPath)
  - workingDirectory
```
public static CommandContext workingDirectory(Path path)
```
    Returns a context that executes commands in the given directory.
    
    Parameters:
    path - the working directory path
    See Also:
    CommandContext.Builder.workingDirectory(Path)
  - getEnvironment
```
public CommandEnvironment getEnvironment()
```
    Returns a copy of this context's CommandEnvironment.
  - getExitStatusVerifier
```
public Predicate<Integer> getExitStatusVerifier()
```
    Returns the predicate this context uses to verify the exit status of commands.
  - getWorkingDirectory
```
public Optional<UniformPath> getWorkingDirectory()
```
    Returns this context's working directory. If the returned Optional is not present, this context uses the system-dependent default working directory.
  - getStdoutWindowSize
```
public Optional<Integer> getStdoutWindowSize()
```
    Returns this context's output window. If the returned Optional is not present, the window size is unlimited.
  - getStderrWindowSize
```
public Optional<Integer> getStderrWindowSize()
```
    Returns this context's error window. If the returned Optional is not present, the window size is unlimited.

Class CommandContext

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

defaultContext

ignoreExitStatus

requireExitStatus

withEnvironment

workingDirectory

workingDirectory

getEnvironment

getExitStatusVerifier

getWorkingDirectory

getStdoutWindowSize

getStderrWindowSize