@NotThreadSafe public abstract class

AbstractScmCommandBuilder

extends AbstractCommandBuilder<B extends CommandBuilder<B>>
implements ScmCommandBuilder<B extends ScmCommandBuilder<B>>

java.lang.Object
↳	com.atlassian.bitbucket.scm.AbstractCommandBuilder<B extends com.atlassian.bitbucket.scm.CommandBuilder<B>>
	↳	com.atlassian.bitbucket.scm.AbstractScmCommandBuilder<B extends com.atlassian.bitbucket.scm.ScmCommandBuilder<B>>

Class Overview

Extends AbstractCommandBuilder and provides a basic implementation of ScmCommandBuilder. As with AbstractCommandBuilder, build(CommandOutputHandler) must be implemented by the derived class.

Summary

Fields
protected String	command	The SCM command to run when the binary is executed, such as "clone" or "diff".

[Expand]

Inherited Fields

From class com.atlassian.bitbucket.scm.AbstractCommandBuilder

Protected Constructors
	AbstractScmCommandBuilder(I18nService i18nService, String binary) Constructs a new `AbstractScmCommandBuilder` and sets the `I18nService` to use for internationalising error messages and the `binary` to execute.
@Deprecated	AbstractScmCommandBuilder(I18nService i18nService, String binary, File workingDirectory) This constructor is deprecated. in 6.4 for removal in 7.0. Use `AbstractScmCommandBuilder(I18nService, String, Path)` instead.
	AbstractScmCommandBuilder(I18nService i18nService, String binary, Path workDir) Constructs a new `AbstractScmCommandBuilder`, sets the `I18nService` to use for internationalising error messages and the `binary` to execute, and optionally sets the `workingDirectory` where it should be executed.

Public Methods
@Nonnull B	command(String value) Ensures the provided `value` is `not blank` and sets it as the `command` to run.

[Expand]

Inherited Methods

From class com.atlassian.bitbucket.scm.AbstractCommandBuilder

@Nonnull B	argument(String argument) Appends the provided `argument` to the `arguments`, after ensuring it is `not blank`.
@Nonnull B	argumentAfter(String anchor, String argument) Finds the index of the specified `anchor` and inserts the provided `argument` immediately after it in the `arguments`.
@Nonnull B	argumentAt(int index, String argument) Inserts the provided `argument` at the specified `index` in the `arguments`, after ensuring it is `not blank`.
@Nonnull B	argumentBefore(String anchor, String argument) Finds the index of the specified `anchor` and inserts the provided `argument` directly before it in the `arguments`.
@Nonnull B	clearArguments() Clears the `arguments`, but does not `null` or replace the list instance.
@Nonnull B	clearEnvironment() Clears the `environment`, but does not `null` or replace the map instance.
@Nonnull B	clearInputHandler() Clears the `inputHandler`, setting it to `null`.
@Nonnull B	defaultErrorHandler() Indicates the default CommandErrorHandler should be applied when `build(CommandOutputHandler)` is called by setting the `errorHandler` to `null`.
@Nonnull B	defaultExitHandler() Indicates the default CommandExitHandler should be applied when `build(CommandOutputHandler)` is called by setting the `exitHandler` to `null`.
@Nonnull B	defaultWorkDir() Indicates the default working directory should be used when `build(CommandOutputHandler)` is called by setting the `workDir` to `null`.
@Deprecated @Nonnull B	defaultWorkingDirectory() This method is deprecated. in 6.4 for removal in 7.0. Use `defaultWorkDir()` instead.
@Deprecated @Nonnull File	directoryExists(File value) This method is deprecated. in 6.4 for removal in 7.0. Use `directoryExists(Path)` instead
@Nonnull Path	directoryExists(Path value) Ensures the provided `File` is not `null`, exists and is a directory.
@Nullable Path	directoryExistsOrIsNull(Path value) Ensures the provided `File` is `null`, or that it exists and is a directory.
@Deprecated @Nullable File	directoryExistsOrIsNull(File value) This method is deprecated. in 6.4 for removal in 7.0. Use `directoryExistsOrIsNull(Path)` instead
@Nonnull B	errorHandler(CommandErrorHandler value) Sets the provided `value` as the `errorHandler` to use for processing the standard error stream when the built command is executed.
@Nonnull B	exitHandler(CommandExitHandler value) Sets the provided `value` as the `exitHandler` to be called when the built command exits or is canceled.
@Nonnull B	inputHandler(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.
String	notBlank(String value, String name) Ensures the provided value is not `null`, empty or blank.
@Nonnull String	notBlank(String argument) Ensures the provided argument is not `null`, empty or blank.
@Nonnull B	rawArgument(String argument) Appends the provided `argument` to the `arguments`, after ensuring it is not `null`.
@Nonnull B	rawArgumentAfter(String anchor, String argument) Finds the index of the specified `anchor` and inserts the provided `argument` immediately after it in the `arguments`.
@Nonnull B	rawArgumentAt(int index, String argument) Inserts the provided `argument` at the specified `index` in the `arguments`, after ensuring it is `not blank`.
@Nonnull B	rawArgumentBefore(String anchor, String argument) Finds the index of the specified `anchor` and inserts the provided `argument` directly before it in the `arguments`.
@Nonnull B	removeEnvironment(String name) Clears the environment variable of the provided `name` if it has been set
abstract B	self() Returns a reference to the current builder, typed correctly to appease Java generics.
@Nonnull 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`.
@Nonnull 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.
@Nonnull B	workDir(Path value) Sets the provided `value` as the `workDir` to use when the built command is executed.
@Deprecated @Nonnull B	workingDirectory(File value) This method is deprecated. in 6.4 for removal in 7.0. Use `workDir(Path)` instead.
@Deprecated @Nonnull B	workingDirectory(Path value) This method is deprecated. in 6.4 for removal in 7.0. Use `workDir(Path)` instead.
@Deprecated @Nonnull B	workingDirectory(String value) This method is deprecated. in 6.4 for removal in 7.0. Use `workDir(String)` instead.

From class java.lang.Object

From interface com.atlassian.bitbucket.scm.CommandBuilder

@Nonnull B	argument(String arg0)
@Nonnull B	argumentAfter(String arg0, String arg1)
@Nonnull B	argumentAt(int arg0, String arg1)
@Nonnull B	argumentBefore(String arg0, String arg1)
@Nonnull B	clearArguments()
@Nonnull B	clearInputHandler()
@Nonnull B	defaultErrorHandler()
@Nonnull B	errorHandler(CommandErrorHandler arg0)
@Nonnull B	inputHandler(CommandInputHandler arg0)
@Nonnull B	rawArgument(String arg0)
@Nonnull B	rawArgumentAfter(String arg0, String arg1)
@Nonnull B	rawArgumentAt(int arg0, String arg1)
@Nonnull B	rawArgumentBefore(String arg0, String arg1)

From interface com.atlassian.bitbucket.scm.CommandBuilderSupport

@Nonnull <T> Command<T>	build(CommandOutputHandler<T> arg0)
@Nonnull B	clearEnvironment()
@Nonnull B	defaultExitHandler()
@Nonnull B	defaultWorkDir()
@Deprecated @Nonnull B	defaultWorkingDirectory()
@Nonnull B	exitHandler(CommandExitHandler arg0)
@Nonnull B	removeEnvironment(String arg0)
@Nonnull B	withEnvironment(String arg0, String arg1)
@Nonnull B	workDir(String arg0)
@Nonnull B	workDir(Path arg0)
@Deprecated @Nonnull B	workingDirectory(File arg0)
@Deprecated @Nonnull B	workingDirectory(Path arg0)
@Deprecated @Nonnull B	workingDirectory(String arg0)

From interface com.atlassian.bitbucket.scm.ScmCommandBuilder

Fields

protected String command

The SCM command to run when the binary is executed, such as "clone" or "diff". This field may be null, but when it is implementations should apply the first argument as the command when building the Command. If no command was set and there are no arguments, implementations are encouraged to throw an IllegalStateException.

Protected Constructors

protected AbstractScmCommandBuilder (I18nService i18nService, String binary)

Constructs a new AbstractScmCommandBuilder 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`

@Deprecated protected AbstractScmCommandBuilder (I18nService i18nService, String binary, File workingDirectory)

This constructor is deprecated.
in 6.4 for removal in 7.0. Use AbstractScmCommandBuilder(I18nService, String, Path) instead.

Constructs a new AbstractScmCommandBuilder, 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`

protected AbstractScmCommandBuilder (I18nService i18nService, String binary, Path workDir)

Constructs a new AbstractScmCommandBuilder, 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`

Public Methods

@Nonnull public B command (String value)

Ensures the provided value is not blank and sets it as the command to run.

Parameters

value	the SCM command to execute

Returns

self()

Interfaces

Classes

Enums

AbstractScmCommandBuilder

Class Overview

Summary

Fields

protected String command

See Also

Protected Constructors

protected AbstractScmCommandBuilder (I18nService i18nService, String binary)

Parameters

Throws

See Also

@Deprecated protected AbstractScmCommandBuilder (I18nService i18nService, String binary, File workingDirectory)

Parameters

Throws

See Also

protected AbstractScmCommandBuilder (I18nService i18nService, String binary, Path workDir)

Parameters

Throws

See Also

Public Methods

@Nonnull public B command (String value)

Parameters

Returns