com.atlassian.bitbucket.scm.git.command.lstree

Interface GitLsTreeBuilder

All Superinterfaces:

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

public interface GitLsTreeBuilder
extends GitCommandBuilderSupport<GitLsTreeBuilder>

A type-safe, argument-safe builder for git ls-tree.

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
GitLsTreeBuilder	clearPaths() reset the paths provided to empty
GitLsTreeBuilder	nullTerminated(boolean value)
GitLsTreeBuilder	path(String path) Offers a way to filter the subtree passed in via tree(String, String) to zero to many paths by matching the name of the node in the tree.
GitLsTreeBuilder	paths(Iterable<String> values)
GitLsTreeBuilder	paths(String value, String... values)
GitLsTreeBuilder	recursive(boolean value)
GitLsTreeBuilder	sizes(boolean value)
GitLsTreeBuilder	tree(String value)
GitLsTreeBuilder	tree(String rev, String file) Offers a convenient shorthand for identifying a subtree in a given commit.

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

clearPaths

@Nonnull
GitLsTreeBuilder clearPaths()

reset the paths provided to empty

Returns:

this

Since:

4.13

nullTerminated

@Nonnull
GitLsTreeBuilder nullTerminated(boolean value)

Parameters:

value - true to pass -z to git ls-tree; otherwise, false

Returns:

this

Since:

4.2

path

@Nonnull
GitLsTreeBuilder path(@Nullable
                               String path)

Offers a way to filter the subtree passed in via tree(String, String) to zero to many paths by matching the name of the node in the tree. For example,

     .tree("master", "src/main/java")
     .path("javafile.java")
 

will ensure that from the "src/main/java" tree, only the file "javafile.java" is selected.

This is not exclusive to files, and the path can be for a file, directory, or submodule.

Parameters:

path - a node on the tree passed to tree(String, String)

Returns:

this

Since:

4.13

paths

@Nonnull
GitLsTreeBuilder paths(@Nullable
                                String value,
                                @Nullable
                                String... values)

Parameters:

value - value

values - values

Returns:

this

Since:

4.13

See Also:

path(String)

paths

@Nonnull
GitLsTreeBuilder paths(@Nullable
                                Iterable<String> values)

Parameters:

values - path iterable

Returns:

this

Since:

4.13

See Also:

path(String)

recursive

@Nonnull
GitLsTreeBuilder recursive(boolean value)

Parameters:

value - true to pass -r to git ls-tree; otherwise, false

Returns:

this

sizes

@Nonnull
GitLsTreeBuilder sizes(boolean value)

Parameters:

value - true to pass -l to git ls-tree; otherwise, false

Returns:

this

Since:

4.2

tree

@Nonnull
GitLsTreeBuilder tree(@Nonnull
                               String value)

Parameters:

value - the tree-ish (typically a commit or tree by ref name or SHA-1) to pass to git ls-tree

Returns:

this

tree

@Nonnull
GitLsTreeBuilder tree(@Nonnull
                               String rev,
                               @Nullable
                               String file)

Offers a convenient shorthand for identifying a subtree in a given commit. For example, passing ("master", "src/main/java") will output the contents of the src/main/java tree on the "master" branch. Note that passing "master:src/main/java" to tree(String) would produce the same output.

Parameters:

rev - the commit to display the tree at, identified by ref name or SHA-1

file - the path of the tree to display, which may be "" to display the root tree

Returns:

this