AbstractCommandBuilder

Maintains an ordered list of arguments. LinkedList is used to optimise insertion, since the argument list is modified more than it is read.

Derived classes may add and remove arguments, but they may not replace the list reference.

The binary to execute when the command is run. This must be provided to the constructor, cannot be null and may not be updated.

Note: When constructing the Command in build(CommandOutputHandler), the derived class may opt to use an alternative, equivalent binary. For example, when using git, give a binary of "git" and a first argument of "http-backend", the builder may opt to call git-http-backend (from libexec/git-core) rather than git http-backend.

Maintains a map of environment variables and their values.

Derived classes may add, replace and remove keys and their values, but they may not replace the map reference.

Note: Java's ProcessBuilder.environment does not support null keys or values. Derived classes should validate entries before they are put into the map to ensure they do not violate that contract.

The CommandErrorHandler to receive and process the InputStream for reading data from the command's error stream. This field may be null, but when it is implementations should apply a default when building the Command. The default should be accumulate error stream output to provide to the CommandExitHandler.

The CommandExitHandler to be invoked when the command runs. This field may be null, but when it is implementations should apply a default when building the Command.

The I18nService, used to internationalise error messages for exceptions thrown during processing.

The CommandInputHandler to receive and process the OutputStream for feeding data into the command. Not all commands will support input, so this field may be null.

The working directory in which the command should be run. Per the contract for ProcessBuilder.directory, this field may be null to use the Java process's working directory.

Constructs a new AbstractCommandBuilder and sets the I18nService to use for internationalising error messages and the binary to execute.

Constructs a new AbstractCommandBuilder, sets the I18nService to use for internationalising error messages and the binary to execute, and optionally sets the workingDirectory where it should be executed.

Appends the provided argument to the arguments, after ensuring it is not blank.

Finds the index of the specified anchor and inserts the provided argument immediately after it in the arguments. If the anchor is not found, the provided argument is appended at the end of the argument list.

Inserts the provided argument at the specified index in the arguments, after ensuring it is not blank.

Finds the index of the specified anchor and inserts the provided argument directly before it in the arguments. If the anchor is not found, the provided argument is appended at the end of the argument list.

Clears the arguments, but does not null or replace the list instance.

Clears the environment, but does not null or replace the map instance.

Clears the inputHandler, setting it to null.

Indicates the default CommandErrorHandler should be applied when build(CommandOutputHandler) is called by setting the errorHandler to null.

Derived classes may override this to preemptively set the default error handler, or they may apply the default in build(CommandOutputHandler) when the errorHandler field is null. The latter is the preferred approach, as it does not require code using the builder to call this method to trigger applying the default handler.

Indicates the default CommandExitHandler should be applied when build(CommandOutputHandler) is called by setting the exitHandler to null.

Derived classes may override this to preemptively set the default exit handler, or they may apply the default in build(CommandOutputHandler) when the exitHandler field is null. The latter is the preferred approach, as it does not require code using the builder to call this method to trigger applying the default handler.

Indicates the default working directory should be used when build(CommandOutputHandler) is called by setting the workingDirectory to null. This is consistent with ProcessBuilder.

Sets the provided value as the errorHandler to use for processing the standard error stream when the built command is executed.

Note: As described on the CommandErrorHandler and CommandExitHandler interfaces, providing an error handler will prevent the exit handler from receiving any output written to the standard error stream.

Sets the provided value as the exitHandler to be called when the built command exits or is canceled.

Note: As described on the CommandErrorHandler and CommandExitHandler interfaces, providing an error handler will prevent the exit handler from receiving any output written to the standard error stream.

Sets the provided value as the inputHandler to use for providing data on the standard input stream when the built command is executed.

Appends the provided argument to the arguments, after ensuring it is not null.

Whitespace: Leading and trailing whitespace on the argument is ignored, and the value is used verbatim.

Finds the index of the specified anchor and inserts the provided argument immediately after it in the arguments. If the anchor is not found, the provided argument is appended at the end of the argument list.

Whitespace: Leading and trailing whitespace on the anchor or argument is ignored, and the values are used verbatim.

Inserts the provided argument at the specified index in the arguments, after ensuring it is not blank.

Whitespace: Leading and trailing whitespace on the argument is ignored, and the value is used verbatim.

Finds the index of the specified anchor and inserts the provided argument directly before it in the arguments. If the anchor is not found, the provided argument is appended at the end of the argument list.

Whitespace: Leading and trailing whitespace on the anchor or argument is ignored, and the values are used verbatim.

Clears the environment variable of the provided name if it has been set

Puts the provided value in the environment map with the specified name, after ensuring both the name and value are not blank.

Sets the provided value as the workingDirectory to use when the built command is executed.

Sets the provided value as the workingDirectory to use when the built command is executed.

Constructs a File from the provided value and sets it as the working directory to use when the built command is executed.

Ensures the provided File is not null, exists and is a directory.

Ensures the provided File is null, or that it exists and is a directory.

Ensures the provided value is not null, empty or blank. The returned value is trimmed to remove both leading and trailing whitespace.

Ensures the provided argument is not null, empty or blank. The returned argument is trimmed to remove both leading and trailing whitespace.

Returns a reference to the current builder, typed correctly to appease Java generics.

Implementations of this method on derived builders are encouraged to use a covariant return type to return the actual implementation class. For example:

     public interface MyBuilder extends CommandBuilder<MyBuilder> {
         //Implementation omitted
     }

     public class DefaultMyBuilder extends AbstractCommandBuilder<MyBuilder> implements MyBuilder {
         //Implementation omitted

         @Override
         protected DefaultMyBuilder self() {
             return this;
         }
     }