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

Interface GitRmBuilder

All Superinterfaces:

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

public interface GitRmBuilder
extends GitCommandBuilderSupport<GitRmBuilder>

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
GitCommand<Void>	build()
GitRmBuilder	force(boolean value)
GitRmBuilder	path(String value)
GitRmBuilder	paths(Iterable<String> values)
GitRmBuilder	paths(String value, String... values)
GitRmBuilder	quiet(boolean value)
GitRmBuilder	recursive(boolean value)
GitRmBuilder	sparse(boolean value)	Controls whether git rm will allow removing 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

build

@Nonnull
GitCommand<Void> build()

force

@Nonnull
GitRmBuilder force(boolean value)

path

@Nonnull
GitRmBuilder path(String value)

paths

@Nonnull
GitRmBuilder paths(Iterable<String> values)

paths

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

quiet

@Nonnull
GitRmBuilder quiet(boolean value)

recursive

@Nonnull
GitRmBuilder recursive(boolean value)

sparse

@Nonnull
GitRmBuilder sparse(boolean value)

Controls whether git rm will allow removing 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 rm, to prevent breaking apps using sparse checkouts, this defaults to true if Git 2.34+ is installed.

Parameters:

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

Returns:

this

Since:

7.19