public
interface
MinimalCommit
| com.atlassian.bitbucket.commit.MinimalCommit |
 Known Indirect Subclasses
|
Class Overview
A minimal commit, defining only identifier information.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| TO_ID |
This field is deprecated.
in 4.0 for removal in 5.0. With Java 8, MinimalCommit::getId can be used instead.
|
||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
An identifier for this commit suitable for display to end users.
| |||||||||||
An identifier for this commit which may be passed to the system in order to retrieve more information related
to it.
| |||||||||||
Fields
public static final Function<MinimalCommit, String> TO_ID
This field is deprecated.
in 4.0 for removal in 5.0. With Java 8, MinimalCommit::getId can be used instead.
Retrieve the ID of a given commit.
See Also
Public Methods
@Nonnull public 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
@Nonnull public 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