com.atlassian.bitbucket.scm

Class CommitsCommandParameters

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.scm.AbstractCommandParameters

com.atlassian.bitbucket.scm.CommitsCommandParameters

public class CommitsCommandParameters
extends AbstractCommandParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommitsCommandParameters.Builder

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Method Summary

Modifier and Type	Method and Description
Set<String>	getExcludes()
Set<String>	getIncludes()
int	getMaxMessageLength()
CommitListMergeFilter	getMerges() Retrieves the strategy being used to filter merge commits.
CommitOrder	getOrder() Retrieves the sort order to use for the commits.
Set<String>	getPaths()
Repository	getSecondaryRepository()
Instant	getSince() Show commits more recent than a specific date.
boolean	hasExcludes()
boolean	hasIncludes()
boolean	hasPaths()
boolean	hasSecondaryRepository()
boolean	hasSince()
boolean	isAll()
boolean	isFollowingRenames() Whether or not the commit history will attempt to follow renames.
boolean	isIgnoringMissing()
boolean	isTraversing()
boolean	isWithMessages()
CommitContext	toContext() Assembles a CommitContext from these parameters.

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getExcludes

@Nonnull
public Set<String> getExcludes()

getIncludes

@Nonnull
public Set<String> getIncludes()

getMaxMessageLength

public int getMaxMessageLength()

Returns:

the maximum length to read for commit messages; if set, messages longer than this will be truncated; -1 indicates unlimited message length

Since:

4.5

getMerges

@Nonnull
public CommitListMergeFilter getMerges()

Retrieves the strategy being used to filter merge commits.

Returns:

how merge commits will be filtered

Since:

4.8

See Also:

CommitListMergeFilter

getOrder

@Nonnull
public CommitOrder getOrder()

Retrieves the sort order to use for the commits.

Returns:

the sort order

Since:

5.0

getPaths

@Nonnull
public Set<String> getPaths()

getSecondaryRepository

@Nullable
public Repository getSecondaryRepository()

getSince

@Nullable
public Instant getSince()

Show commits more recent than a specific date.

Returns:

the Instant which the commits should be more recent than or null if no filter is set

Since:

7.12

hasExcludes

public boolean hasExcludes()

hasIncludes

public boolean hasIncludes()

hasPaths

public boolean hasPaths()

hasSecondaryRepository

public boolean hasSecondaryRepository()

hasSince

public boolean hasSince()

Returns:

true if a since date is specified, false otherwise

Since:

7.12

isAll

public boolean isAll()

isFollowingRenames

public boolean isFollowingRenames()

Whether or not the commit history will attempt to follow renames. This is only applicable for individual file paths

Returns:

true if renames are followed, false otherwise

Since:

4.5

isIgnoringMissing

public boolean isIgnoringMissing()

Returns:

whether or not to ignore missing commits.

Since:

5.0

isTraversing

public boolean isTraversing()

isWithMessages

public boolean isWithMessages()

Returns:

true if commit messages should be included; otherwise, false if they should be omitted

toContext

@Nonnull
public CommitContext toContext()

Assembles a CommitContext from these parameters.

Returns:

a CommitContext describing these parameters