com.atlassian.bitbucket.commit

Class CommitRequest

java.lang.Object

com.atlassian.bitbucket.commit.AbstractCommitRequest

com.atlassian.bitbucket.commit.CommitRequest

public class CommitRequest
extends AbstractCommitRequest

Describes a request for a single commit. If no path is provided, the specified commit will be the one returned. If a path is provided, the commit returned will be the first commit in the ancestry of the specified commit which modifies that path.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommitRequest.Builder

Nested classes/interfaces inherited from class com.atlassian.bitbucket.commit.AbstractCommitRequest

AbstractCommitRequest.AbstractCommitRequestBuilder<B extends AbstractCommitRequest.AbstractCommitRequestBuilder<B>>

Field Summary

Fields inherited from class com.atlassian.bitbucket.commit.AbstractCommitRequest

UNLIMITED_MESSAGE_LENGTH

Method Summary

Modifier and Type	Method and Description
String	getCommitId()
int	getMaxMessageLength()
String	getPath() Retrieves an optional path which is used to control which commit is returned.
Set<String>	getPropertyKeys()
Repository	getRepository()

Methods inherited from class java.lang.Object

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

Method Detail

getCommitId

@Nonnull
public String getCommitId()

Overrides:

getCommitId in class AbstractCommitRequest

Returns:

the commit ID, which may also be specified using a branch ID or tag ID

getMaxMessageLength

public int getMaxMessageLength()

Overrides:

getMaxMessageLength in class AbstractCommitRequest

Returns:

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

Since:

4.5

getPath

@Nullable
public String getPath()

Retrieves an optional path which is used to control which commit is returned. When a path is provided, the commit ID is used as a starting point and may not actually be the commit that ultimately gets returned. Instead, the first commit which modifies the specified path will be returned. If none of the commits in the ancestry of the starting commit modify the specified path, no commit is returned.

Overrides:

getPath in class AbstractCommitRequest

Returns:

an optional path

getPropertyKeys

@Nonnull
public Set<String> getPropertyKeys()

Returns:

a set of property keys to load, which may be empty but never null

getRepository

@Nonnull
public Repository getRepository()

Overrides:

getRepository in class AbstractCommitRequest

Returns:

the repository the commit should be loaded from