com.atlassian.bitbucket.scm.git.command.clone

Interface GitCloneBuilder

All Superinterfaces:

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

public interface GitCloneBuilder
extends GitCommandBuilderSupport<GitCloneBuilder>

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
GitCloneBuilder	branch(String value) The optional name of a branch to checkout the cloned repository on.
GitCommand<?>	build()
GitCloneBuilder	checkout(boolean value)
GitCloneBuilder	directory(File value)
GitCloneBuilder	directory(Path value) Sets the directory where the clone should be created.
GitCloneBuilder	directory(String value)
GitCloneBuilder	origin(File value)
GitCloneBuilder	origin(Path value) Sets the path to the origin repository that should be cloned.
GitCloneBuilder	origin(com.atlassian.bitbucket.repository.Repository value) Sets the origin repository that should be cloned.
GitCloneBuilder	origin(String origin)
GitCloneBuilder	quiet(boolean value)
GitCloneBuilder	shared(boolean value)
GitCloneBuilder	template(File value) Sets the --template path to be used when creating the clone's repository on disk.
GitCloneBuilder	template(Path value) Sets the --template path to be used when creating the clone's repository on disk.
GitCloneBuilder	template(String value) Sets the --template path to be used when creating the clone's repository on disk.

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

build

@Nonnull
GitCommand<?> build()

branch

@Nonnull
GitCloneBuilder branch(@Nullable
                                String value)

The optional name of a branch to checkout the cloned repository on.

NOTE: This must be a branch, Git clone does not accept qualified refs.

Parameters:

value - branch name

Returns:

this

checkout

@Nonnull
GitCloneBuilder checkout(boolean value)

directory

@Nonnull
GitCloneBuilder directory(@Nonnull
                                   File value)

directory

@Nonnull
GitCloneBuilder directory(@Nonnull
                                   Path value)

Sets the directory where the clone should be created.

Parameters:

value - the path to the directory where the clone should be created

Returns:

this

Since:

5.12

directory

@Nonnull
GitCloneBuilder directory(@Nonnull
                                   String value)

origin

@Nonnull
GitCloneBuilder origin(@Nonnull
                                File value)

origin

@Nonnull
GitCloneBuilder origin(@Nonnull
                                Path value)

Sets the path to the origin repository that should be cloned.

Parameters:

value - the path to the origin repository

Returns:

this

Since:

5.12

origin

@Nonnull
GitCloneBuilder origin(@Nonnull
                                com.atlassian.bitbucket.repository.Repository value)

Sets the origin repository that should be cloned.

Parameters:

value - the origin repository

Returns:

this

Since:

5.12

origin

@Nonnull
GitCloneBuilder origin(@Nonnull
                                String origin)

quiet

@Nonnull
GitCloneBuilder quiet(boolean value)

shared

@Nonnull
GitCloneBuilder shared(boolean value)

template

@Nonnull
GitCloneBuilder template(@Nullable
                                  File value)

Sets the --template path to be used when creating the clone's repository on disk. The Git distribution includes its own template, which can be overridden by using this flag.

Parameters:

value - the --template path, or null to clear the flag

Returns:

this

Since:

4.12

template

@Nonnull
GitCloneBuilder template(@Nullable
                                  Path value)

Sets the --template path to be used when creating the clone's repository on disk. The Git distribution includes its own template, which can be overridden by using this flag.

Parameters:

value - the --template path, or null to clear the flag

Returns:

this

Since:

5.12

template

@Nonnull
GitCloneBuilder template(@Nullable
                                  String value)

Sets the --template path to be used when creating the clone's repository on disk. The Git distribution includes its own template, which can be overridden by using this flag.

Parameters:

value - the --template path, or null to clear the flag

Returns:

this

Since:

4.12