AbstractCommandBuilder (Bitbucket Server

java.lang.Object
- com.atlassian.bitbucket.scm.AbstractCommandBuilder

All Implemented Interfaces:

com.atlassian.bitbucket.scm.CommandBuilder, com.atlassian.bitbucket.scm.CommandBuilderSupport

Direct Known Subclasses:

AbstractScmCommandBuilder
```
@NotThreadSafe
public abstract class AbstractCommandBuilder>
extends Object
implements com.atlassian.bitbucket.scm.CommandBuilder
```
Provides a basic implementation of most CommandBuilder functionality, to simplify creating builders. All CommandBuilder and CommandBuilderSupport methods are implemented except for the actual build method.

Field Summary

Fields
Modifier and Type	Field and Description
`protected LinkedList<String>`	`arguments` Maintains an ordered list of arguments.
`protected String`	`binary` The binary to execute when the command is run.
`protected Map<String,String>`	`environment` Maintains a map of environment variables and their values.
`protected com.atlassian.bitbucket.scm.CommandErrorHandler`	`errorHandler` The `CommandErrorHandler` to receive and process the `InputStream` for reading data from the command's error stream.
`protected com.atlassian.bitbucket.scm.CommandExitHandler`	`exitHandler` The `CommandExitHandler` to be invoked when the command runs.
`protected com.atlassian.bitbucket.i18n.I18nService`	`i18nService` The `I18nService`, used to internationalise error messages for exceptions thrown during processing.
`protected com.atlassian.bitbucket.scm.CommandInputHandler`	`inputHandler` The `CommandInputHandler` to receive and process the `OutputStream` for feeding data into the command.
`protected Path`	`workDir` The working directory in which the command should be run.
`protected File`	`workingDirectory` Deprecated. in 6.4 for removal in 8.0. Use `workDir` instead.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCommandBuilder(com.atlassian.bitbucket.i18n.I18nService i18nService, String binary)` Constructs a new `AbstractCommandBuilder` and sets the `I18nService` to use for internationalising error messages and the `binary` to execute.
`protected`	`AbstractCommandBuilder(com.atlassian.bitbucket.i18n.I18nService i18nService, String binary, File workingDirectory)` Deprecated. in 6.4 for removal in 8.0. Use `AbstractCommandBuilder(I18nService, String, Path)` instead.
`protected`	`AbstractCommandBuilder(com.atlassian.bitbucket.i18n.I18nService i18nService, String binary, Path workDir)` 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.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`B`	`argument(String argument)` Appends the provided `argument` to the `arguments`, after ensuring it is `not blank`.
`B`	`argumentAfter(String anchor, String argument)` Finds the index of the specified `anchor` and inserts the provided `argument` immediately after it in the `arguments`.
`B`	`argumentAt(int index, String argument)` Inserts the provided `argument` at the specified `index` in the `arguments`, after ensuring it is `not blank`.
`B`	`argumentBefore(String anchor, String argument)` Finds the index of the specified `anchor` and inserts the provided `argument` directly before it in the `arguments`.
`B`	`clearArguments()` Clears the `arguments`, but does not `null` or replace the list instance.
`B`	`clearEnvironment()` Clears the `environment`, but does not `null` or replace the map instance.
`B`	`clearInputHandler()` Clears the `inputHandler`, setting it to `null`.
`B`	`defaultErrorHandler()` Indicates the default `CommandErrorHandler` should be applied when `CommandBuilderSupport.build(CommandOutputHandler)` is called by setting the `errorHandler` to `null`.
`B`	`defaultExitHandler()` Indicates the default `CommandExitHandler` should be applied when `CommandBuilderSupport.build(CommandOutputHandler)` is called by setting the `exitHandler` to `null`.
`B`	`defaultWorkDir()` Indicates the default working directory should be used when `CommandBuilderSupport.build(CommandOutputHandler)` is called by setting the `workDir` to `null`.
`B`	`defaultWorkingDirectory()` Deprecated. in 6.4 for removal in 8.0. Use `defaultWorkDir()` instead.
`protected File`	`directoryExists(File value)` Deprecated. in 6.4 for removal in 8.0. Use `directoryExists(Path)` instead
`protected Path`	`directoryExists(Path value)` Ensures the provided `File` is not `null`, exists and is a directory.
`protected File`	`directoryExistsOrIsNull(File value)` Deprecated. in 6.4 for removal in 8.0. Use `directoryExistsOrIsNull(Path)` instead
`protected Path`	`directoryExistsOrIsNull(Path value)` Ensures the provided `File` is `null`, or that it exists and is a directory.
`B`	`errorHandler(com.atlassian.bitbucket.scm.CommandErrorHandler value)` Sets the provided `value` as the `errorHandler` to use for processing the standard error stream when the built command is executed.
`B`	`exitHandler(com.atlassian.bitbucket.scm.CommandExitHandler value)` Sets the provided `value` as the `exitHandler` to be called when the built command exits or is canceled.
`B`	`inputHandler(com.atlassian.bitbucket.scm.CommandInputHandler value)` Sets the provided `value` as the `inputHandler` to use for providing data on the standard input stream when the built command is executed.
`protected String`	`notBlank(String argument)` Ensures the provided argument is not `null`, empty or blank.
`protected String`	`notBlank(String value, String name)` Ensures the provided value is not `null`, empty or blank.
`B`	`rawArgument(String argument)` Appends the provided `argument` to the `arguments`, after ensuring it is not `null`.
`B`	`rawArgumentAfter(String anchor, String argument)` Finds the index of the specified `anchor` and inserts the provided `argument` immediately after it in the `arguments`.
`B`	`rawArgumentAt(int index, String argument)` Inserts the provided `argument` at the specified `index` in the `arguments`, after ensuring it is `not blank`.
`B`	`rawArgumentBefore(String anchor, String argument)` Finds the index of the specified `anchor` and inserts the provided `argument` directly before it in the `arguments`.
`B`	`removeEnvironment(String name)` Clears the environment variable of the provided `name` if it has been set
`protected abstract B`	`self()` Returns a reference to the current builder, typed correctly to appease Java generics.
`B`	`withEnvironment(String name, String value)` Puts the provided `value` in the `environment` map with the specified `name`, after ensuring both the `name` and `value` are `not blank`.
`B`	`workDir(Path value)` Sets the provided `value` as the `workDir` to use when the built command is executed.
`B`	`workDir(String value)` Constructs a `Path` from the provided `value` and `sets it` as the working directory to use when the built command is executed.
`B`	`workingDirectory(File value)` Deprecated. in 6.4 for removal in 8.0. Use `workDir(Path)` instead.
`B`	`workingDirectory(Path value)` Deprecated. in 6.4 for removal in 8.0. Use `workDir(Path)` instead.
`B`	`workingDirectory(String value)` Deprecated. in 6.4 for removal in 8.0. Use `workDir(String)` instead.

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

Methods inherited from interface com.atlassian.bitbucket.scm.CommandBuilderSupport
build

- Field Detail
 - arguments
```
protected final LinkedList<String> arguments
```
 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.
 - binary
```
protected final String binary
```
 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 CommandBuilderSupport.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.
 - environment
```
protected final Map<String,String> environment
```
 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.
 - i18nService
```
protected final com.atlassian.bitbucket.i18n.I18nService i18nService
```
 The I18nService, used to internationalise error messages for exceptions thrown during processing.
 - exitHandler
```
protected com.atlassian.bitbucket.scm.CommandExitHandler exitHandler
```
 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.
 
 See Also:
 
 DefaultCommandExitHandler
 - inputHandler
```
protected com.atlassian.bitbucket.scm.CommandInputHandler inputHandler
```
 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.
 - errorHandler
```
protected com.atlassian.bitbucket.scm.CommandErrorHandler errorHandler
```
 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.
 
 See Also:
 
 StringOutputHandler
 - workDir
```
protected Path workDir
```
 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.
 
 Since:
 
 6.4
 - workingDirectory
```
@Deprecated
protected File workingDirectory
```
 Deprecated. in 6.4 for removal in 8.0. Use workDir instead.
 
 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.
- Constructor Detail
 - AbstractCommandBuilder
```
protected AbstractCommandBuilder(@Nonnull
 com.atlassian.bitbucket.i18n.I18nService i18nService,
 @Nonnull
 String binary)
```
 Constructs a new AbstractCommandBuilder and sets the I18nService to use for internationalising error messages and the binary to execute.
 
 Parameters:
 
 i18nService - the I18nService for internationalising error messages
 
 binary - the binary to execute
 
 Throws:
 
 IllegalArgumentException - if the provided binary is empty or blank
 
 NullPointerException - if the provided i18nService or binary is null
 - AbstractCommandBuilder
```
@Deprecated
protected AbstractCommandBuilder(@Nonnull
 com.atlassian.bitbucket.i18n.I18nService i18nService,
 @Nonnull
 String binary,
 @Nullable
 File workingDirectory)
```
 Deprecated. in 6.4 for removal in 8.0. Use AbstractCommandBuilder(I18nService, String, Path) instead.
 
 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.
 
 Parameters:
 
 i18nService - the I18nService for internationalising error messages
 
 binary - the binary to execute
 
 workingDirectory - the working directory for the command, or null for the default
 
 Throws:
 
 IllegalArgumentException - if the provided binary is empty or blank, or if a working directory is provided which does not exist or is not a directory
 
 NullPointerException - if the provided i18nService or binary is null
 - AbstractCommandBuilder
```
protected AbstractCommandBuilder(@Nonnull
 com.atlassian.bitbucket.i18n.I18nService i18nService,
 @Nonnull
 String binary,
 @Nullable
 Path workDir)
```
 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.
 
 Parameters:
 
 i18nService - the I18nService for internationalising error messages
 
 binary - the binary to execute
 
 workDir - the working directory for the command, or null for the default
 
 Throws:
 
 IllegalArgumentException - if the provided binary is empty or blank, or if a working directory is provided which does not exist or is not a directory
 
 NullPointerException - if the provided i18nService or binary is null
 
 Since:
 
 6.4
- Method Detail
 - argument
```
@Nonnull
public B argument(@Nonnull
 String argument)
```
 Appends the provided argument to the arguments, after ensuring it is not blank.
 
 Specified by:
 
 argument in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 argument - the argument to append to the command
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided argument is empty or blank
 
 NullPointerException - if the provided argument is null
 - argumentAfter
```
@Nonnull
public B argumentAfter(@Nonnull
 String anchor,
 @Nonnull
 String argument)
```
 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.
 
 Specified by:
 
 argumentAfter in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 anchor - the argument serving as the anchor for the new argument
 
 argument - the argument to add immediately after the specified anchor
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided anchor or argument is empty or blank
 
 NullPointerException - if the provided anchor or argument is null
 - argumentAt
```
@Nonnull
public B argumentAt(int index,
 @Nonnull
 String argument)
```
 Inserts the provided argument at the specified index in the arguments, after ensuring it is not blank.
 
 Specified by:
 
 argumentAt in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 index - the index at which the argument should be inserted
 
 argument - the argument to insert at the specified index
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided argument is empty or blank
 
 IndexOutOfBoundsException - if the specified index is out of range for the argument list
 
 NullPointerException - if the provided argument is null
 - argumentBefore
```
@Nonnull
public B argumentBefore(@Nonnull
 String anchor,
 @Nonnull
 String argument)
```
 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.
 
 Specified by:
 
 argumentBefore in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 anchor - the argument serving as the anchor for the new argument
 
 argument - the argument to add immediately before the specified anchor
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided anchor or argument is empty or blank
 
 NullPointerException - if the provided anchor or argument is null
 - clearArguments
```
@Nonnull
public B clearArguments()
```
 Clears the arguments, but does not null or replace the list instance.
 
 Specified by:
 
 clearArguments in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Returns:
 
 self()
 - clearEnvironment
```
@Nonnull
public B clearEnvironment()
```
 Clears the environment, but does not null or replace the map instance.
 
 Specified by:
 
 clearEnvironment in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Returns:
 
 self()
 - removeEnvironment
```
@Nonnull
public B removeEnvironment(@Nonnull
 String name)
```
 Clears the environment variable of the provided name if it has been set
 
 Specified by:
 
 removeEnvironment in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Parameters:
 
 name - the name of the environment variable to clear
 
 Returns:
 
 self()
 
 Since:
 
 5.12
 - clearInputHandler
```
@Nonnull
public B clearInputHandler()
```
 Clears the inputHandler, setting it to null.
 
 Specified by:
 
 clearInputHandler in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Returns:
 
 self()
 - defaultErrorHandler
```
@Nonnull
public B defaultErrorHandler()
```
 Indicates the default CommandErrorHandler should be applied when CommandBuilderSupport.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 CommandBuilderSupport.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.
 
 Specified by:
 
 defaultErrorHandler in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Returns:
 
 self()
 - defaultExitHandler
```
@Nonnull
public B defaultExitHandler()
```
 Indicates the default CommandExitHandler should be applied when CommandBuilderSupport.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 CommandBuilderSupport.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.
 
 Specified by:
 
 defaultExitHandler in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Returns:
 
 self()
 - defaultWorkDir
```
@Nonnull
public B defaultWorkDir()
```
 Indicates the default working directory should be used when CommandBuilderSupport.build(CommandOutputHandler) is called by setting the workDir to null. This is consistent with ProcessBuilder.
 
 Specified by:
 
 defaultWorkDir in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Returns:
 
 self()
 
 Since:
 
 6.4
 - defaultWorkingDirectory
```
@Deprecated
 @Nonnull
public B defaultWorkingDirectory()
```
 Deprecated. in 6.4 for removal in 8.0. Use defaultWorkDir() instead.
 
 Indicates the default working directory should be used when CommandBuilderSupport.build(CommandOutputHandler) is called by setting the workDir to null. This is consistent with ProcessBuilder.
 
 Specified by:
 
 defaultWorkingDirectory in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Returns:
 
 self()
 - errorHandler
```
@Nonnull
public B errorHandler(@Nonnull
 com.atlassian.bitbucket.scm.CommandErrorHandler value)
```
 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.
 
 Specified by:
 
 errorHandler in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 value - the handler to receive and process the command's error stream
 
 Returns:
 
 self()
 
 Throws:
 
 NullPointerException - if the provided value is null
 - exitHandler
```
@Nonnull
public B exitHandler(@Nonnull
 com.atlassian.bitbucket.scm.CommandExitHandler value)
```
 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.
 
 Specified by:
 
 exitHandler in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Parameters:
 
 value - the handler which should be invoked when the command exits
 
 Returns:
 
 self()
 
 Throws:
 
 NullPointerException - if the provided value is null
 - inputHandler
```
@Nonnull
public B inputHandler(@Nonnull
 com.atlassian.bitbucket.scm.CommandInputHandler value)
```
 Sets the provided value as the inputHandler to use for providing data on the standard input stream when the built command is executed.
 
 Specified by:
 
 inputHandler in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 value - the handler to receive and process the command's input stream
 
 Returns:
 
 self()
 
 Throws:
 
 NullPointerException - if the provided value is null
 - rawArgument
```
@Nonnull
public B rawArgument(@Nonnull
 String argument)
```
 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.
 
 Specified by:
 
 rawArgument in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 argument - the argument to append to the command
 
 Returns:
 
 self()
 
 Throws:
 
 NullPointerException - if the provided argument is null
 
 Since:
 
 6.0
 - rawArgumentAfter
```
@Nonnull
public B rawArgumentAfter(@Nonnull
 String anchor,
 @Nonnull
 String argument)
```
 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.
 
 Specified by:
 
 rawArgumentAfter in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 anchor - the argument serving as the anchor for the new argument
 
 argument - the argument to add immediately after the specified anchor
 
 Returns:
 
 self()
 
 Throws:
 
 NullPointerException - if the provided anchor or argument is null
 
 Since:
 
 6.0
 - rawArgumentAt
```
@Nonnull
public B rawArgumentAt(int index,
 @Nonnull
 String argument)
```
 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.
 
 Specified by:
 
 rawArgumentAt in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 index - the index at which the argument should be inserted
 
 argument - the argument to insert at the specified index
 
 Returns:
 
 self()
 
 Throws:
 
 IndexOutOfBoundsException - if the specified index is out of range for the argument list
 
 NullPointerException - if the provided argument is null
 
 Since:
 
 6.0
 - rawArgumentBefore
```
@Nonnull
public B rawArgumentBefore(@Nonnull
 String anchor,
 @Nonnull
 String argument)
```
 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.
 
 Specified by:
 
 rawArgumentBefore in interface com.atlassian.bitbucket.scm.CommandBuilder>
 
 Parameters:
 
 anchor - the argument serving as the anchor for the new argument
 
 argument - the argument to add immediately before the specified anchor
 
 Returns:
 
 self()
 
 Throws:
 
 NullPointerException - if the provided anchor or argument is null
 
 Since:
 
 6.0
 - withEnvironment
```
@Nonnull
public B withEnvironment(@Nonnull
 String name,
 @Nonnull
 String value)
```
 Puts the provided value in the environment map with the specified name, after ensuring both the name and value are not blank.
 
 Specified by:
 
 withEnvironment in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Parameters:
 
 name - the name of the environment variable to set
 
 value - the value to set for the environment variable
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided name or value is empty or blank
 
 NullPointerException - if the provided name or value is null
 
 Since:
 
 4.8
 - workDir
```
@Nonnull
public B workDir(@Nonnull
 Path value)
```
 Sets the provided value as the workDir to use when the built command is executed.
 
 Specified by:
 
 workDir in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Parameters:
 
 value - the desired working directory
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided value does not exist, or does not reference a directory
 
 NullPointerException - if the provided value is null
 
 Since:
 
 6.4
 - workDir
```
@Nonnull
public B workDir(@Nonnull
 String value)
```
 Constructs a Path from the provided value and sets it as the working directory to use when the built command is executed.
 
 Specified by:
 
 workDir in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Parameters:
 
 value - the absolute path to the desired working directory
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided value does not exist, or does not reference a directory
 
 NullPointerException - if the provided value is null
 
 Since:
 
 6.4
 - workingDirectory
```
@Deprecated
 @Nonnull
public B workingDirectory(@Nonnull
 File value)
```
 Deprecated. in 6.4 for removal in 8.0. Use workDir(Path) instead.
 
 Sets the provided value as the workDir to use when the built command is executed.
 
 Specified by:
 
 workingDirectory in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Parameters:
 
 value - the desired working directory
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided value does not exist, or does not reference a directory
 
 NullPointerException - if the provided value is null
 - workingDirectory
```
@Deprecated
 @Nonnull
public B workingDirectory(@Nonnull
 Path value)
```
 Deprecated. in 6.4 for removal in 8.0. Use workDir(Path) instead.
 
 Sets the provided value as the workDir to use when the built command is executed.
 
 Specified by:
 
 workingDirectory in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Parameters:
 
 value - the desired working directory
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided value does not exist, or does not reference a directory
 
 NullPointerException - if the provided value is null
 - workingDirectory
```
@Deprecated
 @Nonnull
public B workingDirectory(@Nonnull
 String value)
```
 Deprecated. in 6.4 for removal in 8.0. Use workDir(String) instead.
 
 Constructs a Path from the provided value and sets it as the working directory to use when the built command is executed.
 
 Specified by:
 
 workingDirectory in interface com.atlassian.bitbucket.scm.CommandBuilderSupport>
 
 Parameters:
 
 value - the absolute path to the desired working directory
 
 Returns:
 
 self()
 
 Throws:
 
 IllegalArgumentException - if the provided value does not exist, or does not reference a directory
 
 NullPointerException - if the provided value is null
 - directoryExists
```
@Deprecated
 @Nonnull
protected File directoryExists(@Nonnull
 File value)
```
 Deprecated. in 6.4 for removal in 8.0. Use directoryExists(Path) instead
 
 Ensures the provided File is not null, exists and is a directory.
 
 Parameters:
 
 value - the File to validate
 
 Returns:
 
 the provided value
 
 Throws:
 
 IllegalArgumentException - if the provided value does not exist, or does not reference a directory
 
 NullPointerException - if the provided value is null
 - directoryExists
```
@Nonnull
protected Path directoryExists(@Nonnull
 Path value)
```
 Ensures the provided File is not null, exists and is a directory.
 
 Parameters:
 
 value - the File to validate
 
 Returns:
 
 the provided value
 
 Throws:
 
 IllegalArgumentException - if the provided value does not exist, or does not reference a directory
 
 NullPointerException - if the provided value is null
 
 Since:
 
 6.4
 - directoryExistsOrIsNull
```
@Deprecated
 @Nullable
protected File directoryExistsOrIsNull(@Nullable
 File value)
```
 Deprecated. in 6.4 for removal in 8.0. Use directoryExistsOrIsNull(Path) instead
 
 Ensures the provided File is null, or that it exists and is a directory.
 
 Parameters:
 
 value - the File to validate
 
 Returns:
 
 the provided value, which may be null
 
 Throws:
 
 IllegalArgumentException - if the provided value is not null but does not exist, or does not reference a directory
 - directoryExistsOrIsNull
```
@Nullable
protected Path directoryExistsOrIsNull(@Nullable
 Path value)
```
 Ensures the provided File is null, or that it exists and is a directory.
 
 Parameters:
 
 value - the File to validate
 
 Returns:
 
 the provided value, which may be null
 
 Throws:
 
 IllegalArgumentException - if the provided value is not null but does not exist, or does not reference a directory
 
 Since:
 
 6.4
 - notBlank
```
@Nonnull
protected String notBlank(@Nullable
 String argument)
```
 Ensures the provided argument is not null, empty or blank. The returned argument is trimmed to remove both leading and trailing whitespace.
 
 Parameters:
 
 argument - the argument to validate
 
 Returns:
 
 the provided argument, trimmed
 
 Throws:
 
 IllegalArgumentException - if the provided argument is empty or blank
 
 NullPointerException - if the provided argument is null
 - notBlank
```
protected String notBlank(@Nullable
 String value,
 @Nullable
 String name)
```
 Ensures the provided value is not null, empty or blank. The returned value is trimmed to remove both leading and trailing whitespace.
 
 Parameters:
 
 value - the value to validate
 
 name - the value's name, used in exception messages
 
 Returns:
 
 the provided value, trimmed
 
 Throws:
 
 IllegalArgumentException - if the provided value is empty or blank
 
 NullPointerException - if the provided value is null
 
 Since:
 
 4.8
 - self
```
protected abstract B self()
```
 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;
 }
 }

 
```
 Returns:
 
 this, in a derived class

Class AbstractCommandBuilder<B extends com.atlassian.bitbucket.scm.CommandBuilder<B>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.bitbucket.scm.CommandBuilderSupport

Field Detail

arguments

binary

environment

i18nService

exitHandler

inputHandler

errorHandler

workDir

workingDirectory

Constructor Detail

AbstractCommandBuilder

AbstractCommandBuilder

AbstractCommandBuilder

Method Detail

argument

argumentAfter

argumentAt

argumentBefore

clearArguments

clearEnvironment

removeEnvironment

clearInputHandler

defaultErrorHandler

defaultExitHandler

defaultWorkDir

defaultWorkingDirectory

errorHandler

exitHandler

inputHandler

rawArgument

rawArgumentAfter

rawArgumentAt

rawArgumentBefore

withEnvironment

workDir

workDir

workingDirectory

workingDirectory

workingDirectory

directoryExists

directoryExists

directoryExistsOrIsNull

directoryExistsOrIsNull

notBlank

notBlank

self