Package com.atlassian.bitbucket.commit

Class AbstractCommitRequest

java.lang.Object

com.atlassian.bitbucket.commit.AbstractCommitRequest

Direct Known Subclasses:

CommitRequest, LastModifiedRequest

public abstract class AbstractCommitRequest
extends Object

A base class for requests which take a single commit ID and path.

Since:

4.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractCommitRequest.AbstractCommitRequestBuilder<B extends AbstractCommitRequest.AbstractCommitRequestBuilder<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	AbstractCommitRequest(AbstractCommitRequest.AbstractCommitRequestBuilder<?> builder)

Method Summary

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

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

AbstractCommitRequest

protected AbstractCommitRequest(AbstractCommitRequest.AbstractCommitRequestBuilder<?> builder)

Method Details

getCommitId

@Nonnull
public String getCommitId()

Returns:

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

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

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.

Returns:

an optional path

getRepository

@Nonnull
public Repository getRepository()

Returns:

the repository the commit should be loaded from