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

Interface GitLogBuilder

All Superinterfaces:

com.atlassian.bitbucket.scm.CommandBuilderSupport<GitLogBuilder>, GitCommandBuilderSupport<GitLogBuilder>, GitRevCoreBuilder<GitLogBuilder>

public interface GitLogBuilder
extends GitRevCoreBuilder<GitLogBuilder>

Currently a minimal API for getting logs beyond renaming. May be expanded in the future to offer the union of options of GitRevListBuilder and GitDiffBuilder.

Since:

4.5

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
GitLogBuilder	follow(boolean value)	Controls use of --follow
GitLogBuilder	output(GitDiffOutput value)	Controls what diff output is included with the commit information.

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

Methods inherited from interface com.atlassian.bitbucket.scm.git.command.revlist.GitRevCoreBuilder

all, boundary, branches, clearFiles, clearRevs, file, files, files, format, ignoreMissing, inputHandler, leftOnly, leftRight, limit, merges, order, parents, rev, revs, revs, rightOnly, since, skip, tags, walk

Method Details

follow

@Nonnull
GitLogBuilder follow(boolean value)

Controls use of --follow

Parameters:

value - true to continue listing the history of a file beyond renames (works only for a single file).

Returns:

this

output

@Nonnull
GitLogBuilder output(@Nonnull
 GitDiffOutput value)

Controls what diff output is included with the commit information.

Note that, while all of these flags are supported, they may not have an effect. --check, for example, does not affect the output of git log.

Parameters:

value - the diff output mode for the log command

Returns:

this