Package com.atlassian.bitbucket.scm.git.command

Interface GitWorkTreeCommandBuilder

All Superinterfaces:

com.atlassian.bitbucket.scm.CommandBuilder<GitWorkTreeCommandBuilder>, com.atlassian.bitbucket.scm.CommandBuilderSupport<GitWorkTreeCommandBuilder>, GitCommandBuilderSupport<GitWorkTreeCommandBuilder>, GitTypedCommandBuilder<GitWorkTreeCommandBuilder>, com.atlassian.bitbucket.scm.ScmCommandBuilder<GitWorkTreeCommandBuilder>

@NotThreadSafe
public interface GitWorkTreeCommandBuilder
extends GitTypedCommandBuilder<GitWorkTreeCommandBuilder>

Augments the GitScmCommandBuilder with type-safe builders for commands supported in work trees.

Type-safe builders are not provided for all of the commands supported by the git binary, and the builders that are provided may not expose properties for all of the different arguments or argument combinations the command offers. Free-form and type-safe builder semantics may not be mixed. If a type-safe builder does not exist for the desired command, or it does not support the desired arguments, the free-form builder must be used instead.

For type-safe builders provided, the git command associated with the builder is used to name the interface and the method.

Since:

7.14

Field Summary

Fields inherited from interface com.atlassian.bitbucket.scm.git.command.GitCommandBuilderSupport

ENV_AUTHOR_DATE, ENV_AUTHOR_EMAIL, ENV_AUTHOR_NAME, ENV_COMMITTER_DATE, ENV_COMMITTER_EMAIL, ENV_COMMITTER_NAME

Method Summary

Modifier and Type	Method	Description
GitAddBuilder	add()
<T> GitCommand<T>	build(com.atlassian.bitbucket.scm.CommandOutputHandler<T> outputHandler)	Builds a GitCommand which, when executed, will provide output to the provided outputHandler for processing.
GitCommitBuilder	commit()
GitConfig	config()
GitMerge	merge()
GitMvBuilder	mv()	Creates a builder for the git mv command.
GitRemote	remote()
GitResetBuilder	reset()
GitRmBuilder	rm()
GitStatusBuilder	status()

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

argument, argumentAfter, argumentAt, argumentBefore, clearArguments, clearInputHandler, defaultErrorHandler, errorHandler, inputHandler, rawArgument, rawArgumentAfter, rawArgumentAt, rawArgumentBefore

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

clearEnvironment, defaultExitHandler, exitHandler, removeEnvironment, withEnvironment

Methods inherited from interface com.atlassian.bitbucket.scm.git.command.GitCommandBuilderSupport

alternate, alternates, alternates, author, author, author, commitish, committer, committer, committer, treeish, withConfiguration, withConfiguration, withConfiguration, withConfiguration

Methods inherited from interface com.atlassian.bitbucket.scm.git.command.GitTypedCommandBuilder

archive, blame, branch, catFile, checkRefFormat, countObjects, diff, diffTree, fetch, forEachRef, formatPatch, log, lsFiles, lsTree, mergeBase, notes, packObjects, push, revList, tag, updateRef, version

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

command

Method Details

add

@Nonnull
GitAddBuilder add()

build

@Nonnull
<T> GitCommand<T> build(@Nonnull
 com.atlassian.bitbucket.scm.CommandOutputHandler<T> outputHandler)

Builds a GitCommand which, when executed, will provide output to the provided outputHandler for processing.

Specified by:

build in interface com.atlassian.bitbucket.scm.CommandBuilderSupport<GitWorkTreeCommandBuilder>

Specified by:

build in interface GitCommandBuilderSupport<GitWorkTreeCommandBuilder>

Specified by:

build in interface com.atlassian.bitbucket.scm.ScmCommandBuilder<GitWorkTreeCommandBuilder>

Type Parameters:

T - type for the builder

Parameters:

outputHandler - the handler to receive and process output from the command as it executes

Returns:

the built command

Throws:

NullPointerException - if the provided outputHandler is null

commit

@Nonnull
GitCommitBuilder commit()

config

@Nonnull
GitConfig config()

merge

@Nonnull
GitMerge merge()

mv

@Nonnull
GitMvBuilder mv()

Creates a builder for the git mv command.

Note that git mv can only be used in GitCheckoutType.NONE work trees, and only when the source path is first checked out using git checkout HEAD -- <path>.

In sparse checkouts, git mv fails when the source or destination paths are not included in the sparse checkout patterns, which cannot be controlled through the work tree API at this time. For sparse checkouts, use a combination of git rm, GitWorkTree.write(String, Charset, IoConsumer) and git add instead.

Returns:

a builder for git mv operations

remote

@Nonnull
GitRemote remote()

reset

@Nonnull
GitResetBuilder reset()

rm

@Nonnull
GitRmBuilder rm()

status

@Nonnull
GitStatusBuilder status()