GitScmCommandBuilder (Bitbucket Server

All Superinterfaces:

com.atlassian.bitbucket.scm.CommandBuilder<GitScmCommandBuilder>, com.atlassian.bitbucket.scm.CommandBuilderSupport<GitScmCommandBuilder>, GitCommandBuilderSupport<GitScmCommandBuilder>, com.atlassian.bitbucket.scm.ScmCommandBuilder<GitScmCommandBuilder>
```
@NotThreadSafe
public interface GitScmCommandBuilder
extends GitCommandBuilderSupport<GitScmCommandBuilder>, com.atlassian.bitbucket.scm.ScmCommandBuilder<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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GitAddBuilder`	`add()`
`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()`
`GitClone`	`clone()`
`GitCommitBuilder`	`commit()`
`GitConfig`	`config()`
`GitDiffBuilder`	`diff()`
`GitDiffTreeBuilder`	`diffTree()`
`GitFetchBuilder`	`fetch()`
`GitForEachRefBuilder`	`forEachRef()`
`GitFormatPatchBuilder`	`formatPatch()`
`GitGcBuilder`	`gc()`
`GitInitBuilder`	`init()`
`GitLogBuilder`	`log()`
`GitLsFilesBuilder`	`lsFiles()`
`GitLsTreeBuilder`	`lsTree()`
`GitMerge`	`merge()`
`GitMergeBase`	`mergeBase()`
`GitNotes`	`notes()`
`GitPackObjectsBuilder`	`packObjects()`
`GitPrunePackedBuilder`	`prunePacked()`
`GitPushBuilder`	`push()`
`GitRemote`	`remote()`
`GitResetBuilder`	`reset()`
`GitRevListBuilder`	`revList()`
`GitRmBuilder`	`rm()`
`GitStatusBuilder`	`status()`
`GitSymbolicRef`	`symbolicRef()`
`GitTag`	`tag()`
`GitUpdateRef`	`updateRef()`
`<T> com.atlassian.bitbucket.scm.Command<T>`	`version(com.atlassian.bitbucket.scm.CommandOutputHandler<T> outputHandler)`

Methods inherited from interface com.atlassian.bitbucket.scm.git.command.GitCommandBuilderSupport
alternate, alternates, alternates, author, author, author, committer, committer, committer, 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, defaultWorkDir, defaultWorkingDirectory, exitHandler, removeEnvironment, withEnvironment, workDir, workDir, workingDirectory, workingDirectory, workingDirectory

Method Detail

add
```
@Nonnull
GitAddBuilder add()
```

archive
```
@Nonnull
GitArchiveBuilder archive()
```
Returns:

a builder for the git archive command

Since:

5.1

blame
```
@Nonnull
GitBlame blame()
```

branch
```
@Nonnull
GitBranch branch()
```

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()
```

checkRefFormat
```
@Nonnull
GitCheckRefFormat checkRefFormat()
```
Returns:

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

clone
```
@Nonnull
GitClone clone()
```

commit
```
@Nonnull
GitCommitBuilder commit()
```

config
```
@Nonnull
GitConfig config()
```

diff
```
@Nonnull
GitDiffBuilder diff()
```

diffTree
```
@Nonnull
GitDiffTreeBuilder diffTree()
```

fetch
```
@Nonnull
GitFetchBuilder fetch()
```

forEachRef

@Nonnull
GitForEachRefBuilder forEachRef()

formatPatch
```
@Nonnull
GitFormatPatchBuilder formatPatch()
```
Returns:

a builder for the git format-patch command

Since:

6.7

gc
```
@Nonnull
GitGcBuilder gc()
```

init
```
@Nonnull
GitInitBuilder init()
```

log
```
@Nonnull
GitLogBuilder log()
```
Returns:

the git log builder

Since:

4.5

lsFiles
```
@Nonnull
GitLsFilesBuilder lsFiles()
```

lsTree
```
@Nonnull
GitLsTreeBuilder lsTree()
```

merge
```
@Nonnull
GitMerge merge()
```

mergeBase
```
@Nonnull
GitMergeBase mergeBase()
```

notes
```
@Nonnull
GitNotes notes()
```

packObjects

@Nonnull
GitPackObjectsBuilder packObjects()

prunePacked

@Nonnull
GitPrunePackedBuilder prunePacked()

push
```
@Nonnull
GitPushBuilder push()
```

remote
```
@Nonnull
GitRemote remote()
```

reset
```
@Nonnull
GitResetBuilder reset()
```

revList
```
@Nonnull
GitRevListBuilder revList()
```

rm
```
@Nonnull
GitRmBuilder rm()
```

status
```
@Nonnull
GitStatusBuilder status()
```

symbolicRef
```
@Nonnull
GitSymbolicRef symbolicRef()
```

tag
```
@Nonnull
GitTag tag()
```
Returns:

a builder for the git tag command

updateRef
```
@Nonnull
GitUpdateRef updateRef()
```

version

@Nonnull
<T> com.atlassian.bitbucket.scm.Command<T> version(@Nonnull
                                                            com.atlassian.bitbucket.scm.CommandOutputHandler<T> outputHandler)

Interface GitScmCommandBuilder

Field Summary

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

Method Summary

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

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

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

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

Method Detail

add

archive

blame

branch

build

catFile

checkRefFormat

clone

commit

config

diff

diffTree

fetch

forEachRef

formatPatch

gc

init

log

lsFiles

lsTree

merge

mergeBase

notes

packObjects

prunePacked

push

remote

reset

revList

rm

status

symbolicRef

tag

updateRef

version