public interface

MinimalRef

com.atlassian.bitbucket.repository.MinimalRef
Known Indirect Subclasses

Class Overview

A minimal abstraction for a ref within a Repository, describing only the ref's name.

Summary

Fields
public static final Function<MinimalRefString> TO_DISPLAY_ID This field is deprecated. in 4.0 for removal in 5.0. With Java 8, MinimalRef::getDisplayId can be used instead.
public static final Function<MinimalRefString> TO_ID This field is deprecated. in 4.0 for removal in 5.0. With Java 8, MinimalRef::getId can be used instead.
Public Methods
@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()

Fields

public static final Function<MinimalRefString> TO_DISPLAY_ID

This field is deprecated.
in 4.0 for removal in 5.0. With Java 8, MinimalRef::getDisplayId can be used instead.

public static final Function<MinimalRefString> TO_ID

This field is deprecated.
in 4.0 for removal in 5.0. With Java 8, MinimalRef::getId can be used instead.

Public Methods

@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 ()

Returns
  • the type of ref