com.atlassian.bitbucket.scm.git.command

Interface GitScmCommandBuilder

All Superinterfaces:

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

@NotThreadSafe
public interface GitScmCommandBuilder
extends GitTypedCommandBuilder<GitScmCommandBuilder>

Augments the free-form ScmCommandBuilder with git-specific type-safe builders, to simplify using well-known commands.

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. Note that some commands accept arguments which, when provided, enable the use of other arguments, or trigger the command to produce significantly different output. For such commands, like blame and cat-file, an interim interface is returned to allow the caller to choose the "mode" the command will run in. Once a mode has been chosen, a builder will be returned exposing arguments supported for that mode.

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 and Description
GitArchiveBuilder	archive()
GitBlame	blame()
GitBranch	branch()
<T> GitCommand<T>	build(com.atlassian.bitbucket.scm.CommandOutputHandler<T> outputHandler) In addition to all contracts for the parent interface, mandates that built commands be GitCommands, which support both synchronous and asynchronous execution, rather than simple Commands.
GitCatFile	catFile()
GitCheckRefFormat	checkRefFormat()
GitCountObjectsBuilder	countObjects()
GitDiffBuilder	diff()
GitDiffTreeBuilder	diffTree()
GitFetchBuilder	fetch()
GitForEachRefBuilder	forEachRef()
GitFormatPatchBuilder	formatPatch()
GitLogBuilder	log()
GitLsFilesBuilder	lsFiles()
GitLsTreeBuilder	lsTree()
GitMergeBase	mergeBase()
GitNotes	notes()
GitPackObjectsBuilder	packObjects()
GitPushBuilder	push()
GitRevListBuilder	revList()
GitTag	tag()
GitUpdateRef	updateRef()
com.atlassian.bitbucket.util.Version	version() Retrieves the version of the current git binary, if an acceptable version is installed.

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.ScmCommandBuilder

command

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

Method Detail

archive

@Nonnull
GitArchiveBuilder archive()

Specified by:

archive in interface GitTypedCommandBuilder<GitScmCommandBuilder>

Returns:

a builder for the git archive command

Since:

5.1

blame

@Nonnull
GitBlame blame()

Specified by:

blame in interface GitTypedCommandBuilder<GitScmCommandBuilder>

branch

@Nonnull
GitBranch branch()

Specified by:

branch in interface GitTypedCommandBuilder<GitScmCommandBuilder>

build

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

Description copied from interface: GitCommandBuilderSupport

In addition to all contracts for the parent interface, mandates that built commands be GitCommands, which support both synchronous and asynchronous execution, rather than simple Commands.

Specified by:

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

Specified by:

build in interface GitCommandBuilderSupport<GitScmCommandBuilder>

Specified by:

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

Type Parameters:

T - The type of object, or object graph, which the output handler will process from the command's output

Parameters:

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

Returns:

the built command

catFile

@Nonnull
GitCatFile catFile()

Specified by:

catFile in interface GitTypedCommandBuilder<GitScmCommandBuilder>

checkRefFormat

@Nonnull
GitCheckRefFormat checkRefFormat()

Specified by:

checkRefFormat in interface GitTypedCommandBuilder<GitScmCommandBuilder>

Returns:

a type-safe parent builder for the git check-ref-format command

countObjects

@Nonnull
GitCountObjectsBuilder countObjects()

Specified by:

countObjects in interface GitTypedCommandBuilder<GitScmCommandBuilder>

diff

@Nonnull
GitDiffBuilder diff()

Specified by:

diff in interface GitTypedCommandBuilder<GitScmCommandBuilder>

diffTree

@Nonnull
GitDiffTreeBuilder diffTree()

Specified by:

diffTree in interface GitTypedCommandBuilder<GitScmCommandBuilder>

fetch

@Nonnull
GitFetchBuilder fetch()

Specified by:

fetch in interface GitTypedCommandBuilder<GitScmCommandBuilder>

forEachRef

@Nonnull
GitForEachRefBuilder forEachRef()

Specified by:

forEachRef in interface GitTypedCommandBuilder<GitScmCommandBuilder>

formatPatch

@Nonnull
GitFormatPatchBuilder formatPatch()

Specified by:

formatPatch in interface GitTypedCommandBuilder<GitScmCommandBuilder>

Returns:

a builder for the git format-patch command

Since:

6.7

log

@Nonnull
GitLogBuilder log()

Specified by:

log in interface GitTypedCommandBuilder<GitScmCommandBuilder>

Returns:

the git log builder

Since:

4.5

lsFiles

@Nonnull
GitLsFilesBuilder lsFiles()

Specified by:

lsFiles in interface GitTypedCommandBuilder<GitScmCommandBuilder>

lsTree

@Nonnull
GitLsTreeBuilder lsTree()

Specified by:

lsTree in interface GitTypedCommandBuilder<GitScmCommandBuilder>

mergeBase

@Nonnull
GitMergeBase mergeBase()

Specified by:

mergeBase in interface GitTypedCommandBuilder<GitScmCommandBuilder>

notes

@Nonnull
GitNotes notes()

Specified by:

notes in interface GitTypedCommandBuilder<GitScmCommandBuilder>

packObjects

@Nonnull
GitPackObjectsBuilder packObjects()

Specified by:

packObjects in interface GitTypedCommandBuilder<GitScmCommandBuilder>

push

@Nonnull
GitPushBuilder push()

Specified by:

push in interface GitTypedCommandBuilder<GitScmCommandBuilder>

revList

@Nonnull
GitRevListBuilder revList()

Specified by:

revList in interface GitTypedCommandBuilder<GitScmCommandBuilder>

tag

@Nonnull
GitTag tag()

Specified by:

tag in interface GitTypedCommandBuilder<GitScmCommandBuilder>

Returns:

a builder for the git tag command

updateRef

@Nonnull
GitUpdateRef updateRef()

Specified by:

updateRef in interface GitTypedCommandBuilder<GitScmCommandBuilder>

version

@Nonnull
com.atlassian.bitbucket.util.Version version()

Description copied from interface: GitTypedCommandBuilder

Retrieves the version of the current git binary, if an acceptable version is installed. If git was not found, or if it is not an acceptable version, an exception is thrown.

This method should only be used after system startup is complete. For example, it should not be called in constructors, as doing so may result in an exception that causes the plugin to fail to start.

Specified by:

version in interface GitTypedCommandBuilder<GitScmCommandBuilder>

Returns:

the git version in use, if an acceptable version is installed; otherwise, an exception is thrown

Since:

7.14