public class

SimpleMinimalRef

extends Object
implements MinimalRef
java.lang.Object
   ↳ com.atlassian.bitbucket.repository.SimpleMinimalRef

Summary

Nested Classes
class SimpleMinimalRef.AbstractMinimalRefBuilder<B extends AbstractMinimalRefBuilder<B, R extends MinimalRef>, R>  
class SimpleMinimalRef.Builder  
[Expand]
Inherited Fields
From interface com.atlassian.bitbucket.repository.MinimalRef
Protected Constructors
SimpleMinimalRef(AbstractMinimalRefBuilder<?, ?> builder, RefType type)
Public Methods
boolean equals(Object o)
@Nonnull String getDisplayId()
An identifier for this reference suitable for display to end users.
@Nonnull String getId()
The absolute identifier of this reference, which should never be ambiguous within the backing Repository.
@Nonnull RefType getType()
int hashCode()
String toString()
Protected Methods
@Nonnull String fieldsToString()
Override this to add additional sub-class specific information to toString().
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.bitbucket.repository.MinimalRef

Protected Constructors

protected SimpleMinimalRef (AbstractMinimalRefBuilder<?, ?> builder, RefType type)

Public Methods

public boolean equals (Object o)

@Nonnull public String getDisplayId ()

An identifier for this reference 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 practise, however, the returned identifier should be sensible for users familiar with the underlying SCM.

Returns
  • the reference's display identifier

@Nonnull public String getId ()

The absolute identifier of this reference, which should never be ambiguous within the backing Repository.

When performing operations which accept a commit ID, this is the value that should be used to ensure there are no ambiguities. Using getDisplayId() may result in unexpected behaviour.

Returns
  • the reference's absolute identifier

@Nonnull public RefType getType ()

public int hashCode ()

public String toString ()

Protected Methods

@Nonnull protected String fieldsToString ()

Override this to add additional sub-class specific information to toString().

Returns
  • String that will be used in this object's toString(). The format is expected to be "field1=value1, field2=value2", the caller takes care of surrounding it with a class name and braces.