public abstract class

AbstractCommitRequest

extends Object
java.lang.Object
   ↳ com.atlassian.bitbucket.commit.AbstractCommitRequest
Known Direct Subclasses

Class Overview

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

Summary

Nested Classes
class AbstractCommitRequest.AbstractCommitRequestBuilder<B extends AbstractCommitRequestBuilder<B>>  
Constants
int UNLIMITED_MESSAGE_LENGTH A symbolic constant for max message length which means the full commit message should be read regardless of length.
Protected Constructors
AbstractCommitRequest(AbstractCommitRequestBuilder<?> builder)
Public Methods
@Nonnull String getCommitId()
int getMaxMessageLength()
@Nullable String getPath()
Retrieves an optional path which is used to control which commit is returned.
@Nonnull Repository getRepository()
[Expand]
Inherited Methods
From class java.lang.Object

Constants

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.

Constant Value: -1 (0xffffffff)

Protected Constructors

protected AbstractCommitRequest (AbstractCommitRequestBuilder<?> builder)

Public Methods

@Nonnull public String getCommitId ()

Returns

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

@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

@Nonnull public Repository getRepository ()

Returns
  • the repository the commit should be loaded from