Summary: Fields | Methods | [Expand All]
public interface

MinimalRef

com.atlassian.stash.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<MinimalRef, String> TO_DISPLAY_ID
public static final Function<MinimalRef, String> TO_ID
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.

Fields

public static final Function<MinimalRef, String> TO_DISPLAY_ID

public static final Function<MinimalRef, String> TO_ID

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 changeset 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