com.atlassian.bitbucket.commit

Interface MinimalCommit

All Known Subinterfaces:

Commit, MinimalRepositoryCommit

All Known Implementing Classes:

SimpleCommit, SimpleMinimalCommit, SimpleMinimalRepositoryCommit

public interface MinimalCommit

A minimal commit, defining only identifier information.

Method Summary

Modifier and Type	Method and Description
String	getDisplayId() An identifier for this commit suitable for display to end users.
String	getId() An identifier for this commit which may be passed to the system in order to retrieve more information related to it.

Method Detail

getDisplayId

@Nonnull
String getDisplayId()

An identifier for this commit suitable for display to end users.

No guarantees are made as to how this identifier differs from getId()--they may be identical or not, at the whim of the underlying SCM implementation. In practice, however, the returned identifier should be sensible for users familiar with the underlying SCM.

Returns:

a display ID

getId

@Nonnull
String getId()

An identifier for this commit which may be passed to the system in order to retrieve more information related to it.

Returns:

a commit ID