Package com.atlassian.bitbucket.commit

Class AbstractCommitsRequest

java.lang.Object

com.atlassian.bitbucket.commit.AbstractCommitsRequest

Direct Known Subclasses:

CommitsBetweenRequest, CommitsRequest

public abstract class AbstractCommitsRequest
extends Object

A base class for requests to retrieve a series of commits.

Since:

4.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractCommitsRequest.AbstractCommitsRequestBuilder<B extends AbstractCommitsRequest.AbstractCommitsRequestBuilder<B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	UNLIMITED_MESSAGE_LENGTH	A symbolic constant for max message length which means the full commit message should be read regardless of length.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCommitsRequest(AbstractCommitsRequest.AbstractCommitsRequestBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
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()	Retrieves paths, which may identify directories or files within the repository, which are used to limit returned commits.
Set<String>	getPropertyKeys()	Retrieves the keys of index properties to load for returned commits.
Repository	getRepository()
boolean	isFollowingRenames()	Whether or not the commit history will attempt to follow renames.
boolean	isIgnoringMissing()

Methods inherited from class java.lang.Object

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

Field Details

UNLIMITED_MESSAGE_LENGTH

public static final int UNLIMITED_MESSAGE_LENGTH

A symbolic constant for max message length which means the full commit message should be read regardless of length.

See Also:

• Constant Field Values

Constructor Details

AbstractCommitsRequest

protected AbstractCommitsRequest(AbstractCommitsRequest.AbstractCommitsRequestBuilder<?> builder)

Method Details

getMaxMessageLength

public int getMaxMessageLength()

Returns:

the max message length to be processed for any of the commits, which may be UNLIMITED_MESSAGE_LENGTH to include the full commit message regardless of length

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()

Retrieves paths, which may identify directories or files within the repository, which are used to limit returned commits. When multiple paths are provided, commits which modify any of the specified paths may be returned.

Returns:

a set containing zero or more paths

getPropertyKeys

@Nonnull
public Set<String> getPropertyKeys()

Retrieves the keys of index properties to load for returned commits.

Returns:

a set containing zero or more commit attributes to load

See Also:

• CommitIndex.getProperties(String, Iterable)
• CommitIndex.getProperties(Iterable, Iterable)

getRepository

@Nonnull
public Repository getRepository()

Returns:

the repository the commits should be loaded from

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

isIgnoringMissing

public boolean isIgnoringMissing()

Returns:

whether or not to ignore missing commits, or null to let the application figure out whether to do so.

Since:

5.0