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

Interface GitAddBuilder

All Superinterfaces:

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

public interface GitAddBuilder
extends GitCommandBuilderSupport<GitAddBuilder>

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	all(boolean value)
GitCommand<Void>	build()
GitAddBuilder	force(boolean value)	Controls whether --force is passed to git add.
GitAddBuilder	path(String value)
GitAddBuilder	paths(Iterable<String> values)
GitAddBuilder	paths(String value, String... values)
GitAddBuilder	sparse(boolean value)	Controls whether git add will allow adding index entries for files outside a sparse checkout's cone.

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, build, commitish, committer, committer, committer, treeish, withConfiguration, withConfiguration, withConfiguration, withConfiguration

Method Details

all

@Nonnull
GitAddBuilder all(boolean value)

build

@Nonnull
GitCommand<Void> build()

force

@Nonnull
GitAddBuilder force(boolean value)

Controls whether --force is passed to git add. When provided, --force overrides entries from .gitignore, allowing ignored files to be added to the index and committed.

Parameters:

value - true to use --force, overriding .gitignore; otherwise, false to perform a "safe" git add

Returns:

this

path

@Nonnull
GitAddBuilder path(String value)

paths

@Nonnull
GitAddBuilder paths(Iterable<String> values)

paths

@Nonnull
GitAddBuilder paths(String value,
 String... values)

sparse

@Nonnull
GitAddBuilder sparse(boolean value)

Controls whether git add will allow adding index entries for files outside a sparse checkout's cone. If the checkout is not sparse, this flag does nothing.

Note: This flag was introduced in Git 2.34. Calling this if the installed Git is 2.33 or older will automatically no-op, and --sparse will not be passed on the built command. Unlike git add, to prevent breaking apps using sparse checkouts, this defaults to true if Git 2.34+ is installed.

Parameters:

value - true to enable adding files outside the sparse checkout; otherwise, false to refuse to add such files

Returns:

this

Since:

7.19