com.atlassian.bitbucket.scm.git.command.fetch

Interface GitFetchBuilder

All Superinterfaces:

com.atlassian.bitbucket.scm.CommandBuilderSupport<GitFetchBuilder>, GitCommandBuilderSupport<GitFetchBuilder>

public interface GitFetchBuilder
extends GitCommandBuilderSupport<GitFetchBuilder>

A builder which can be used to construct a command for running git fetch.

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
GitFetchBuilder	clearRefspecs() Clears any refspecs which have been added, allowing the same builder to be reused when constructing multiple fetches for different refs.
GitFetchBuilder	errorHandler(com.atlassian.bitbucket.scm.CommandErrorHandler value) Registers the provided error handler to receive stderr output when the built command is run.
GitFetchBuilder	force(boolean value)
GitFetchBuilder	progress(boolean value)
GitFetchBuilder	prune(boolean value) Specifies whether to supply --prune to prune local branches and tags where the upstream branch or tag has been deleted.
GitFetchBuilder	quiet(boolean value)
GitFetchBuilder	refspec(String value)
GitFetchBuilder	refspecs(Iterable<String> values)
GitFetchBuilder	refspecs(String value, String... values)
GitFetchBuilder	repository(File value) Deprecated. in 6.4 for removal in 7.0. Use repository(Path) or repository(Repository) instead.
GitFetchBuilder	repository(Path value)
GitFetchBuilder	repository(com.atlassian.bitbucket.repository.Repository value) Specifies which upstream repository to fetch from.
GitFetchBuilder	repository(String value)
GitFetchBuilder	tags(GitFetchTagMode value) Specifies --tags or --no-tags, to control whether git fetch fetches tags, and which tags it fetches.

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

alternate, alternates, alternates, author, author, author, build, committer, committer, committer, withConfiguration, withConfiguration, withConfiguration, withConfiguration

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

clearEnvironment, defaultExitHandler, defaultWorkDir, defaultWorkingDirectory, exitHandler, removeEnvironment, withEnvironment, workDir, workDir, workingDirectory, workingDirectory, workingDirectory

Method Detail

clearRefspecs

@Nonnull
GitFetchBuilder clearRefspecs()

Clears any refspecs which have been added, allowing the same builder to be reused when constructing multiple fetches for different refs.

Returns:

this

errorHandler

@Nonnull
GitFetchBuilder errorHandler(@Nonnull
                                      com.atlassian.bitbucket.scm.CommandErrorHandler value)

Registers the provided error handler to receive stderr output when the built command is run.

git fetch outputs the refs that are updated to stderr, not stdout, so in order to parse the refs that change callers must register an error handler, not an output handler.

Parameters:

value - the handler to receive stderr output

Returns:

this

force

@Nonnull
GitFetchBuilder force(boolean value)

progress

@Nonnull
GitFetchBuilder progress(boolean value)

prune

@Nonnull
GitFetchBuilder prune(boolean value)

Specifies whether to supply --prune to prune local branches and tags where the upstream branch or tag has been deleted.

Parameters:

value - true if local refs which do not exist upstream should be pruned; otherwise false to leave such refs in place

Returns:

this

Since:

4.1

quiet

@Nonnull
GitFetchBuilder quiet(boolean value)

refspec

@Nonnull
GitFetchBuilder refspec(String value)

refspecs

@Nonnull
GitFetchBuilder refspecs(Iterable<String> values)

refspecs

@Nonnull
GitFetchBuilder refspecs(String value,
                                  String... values)

repository

@Deprecated
 @Nonnull
GitFetchBuilder repository(File value)

Deprecated. in 6.4 for removal in 7.0. Use repository(Path) or repository(Repository) instead.

Parameters:

value - the directory of the upstream repository to fetch from

Returns:

this

repository

@Nonnull
GitFetchBuilder repository(Path value)

Parameters:

value - the directory of the upstream repository to fetch from

Returns:

this

Since:

6.4

repository

@Nonnull
GitFetchBuilder repository(com.atlassian.bitbucket.repository.Repository value)

Specifies which upstream repository to fetch from.

Parameters:

value - the repository to fetch from

Returns:

this

Since:

5.12

repository

@Nonnull
GitFetchBuilder repository(String value)

tags

@Nonnull
GitFetchBuilder tags(@Nonnull
                              GitFetchTagMode value)

Specifies --tags or --no-tags, to control whether git fetch fetches tags, and which tags it fetches.

Parameters:

value - the tag mode for the command

Returns:

this