Package org.projectnessie.versioned

Interface GetNamedRefsParams.RetrieveOptions

Enclosing interface:

GetNamedRefsParams

@Immutable
public static interface GetNamedRefsParams.RetrieveOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final GetNamedRefsParams.RetrieveOptions	BARE	Constant to retrieve only the HEAD commit hash.
static final GetNamedRefsParams.RetrieveOptions	BASE_REFERENCE_RELATED_AND_COMMIT_META	Constant to retrieve the HEAD commit hash, the commit-meta of the HEAD commit, the common-ancestor to the base reference and the commits ahead and behind relative to the base reference.
static final GetNamedRefsParams.RetrieveOptions	COMMIT_META	Constant to retrieve the HEAD commit hash plus the commit-meta of the HEAD commit.
static final GetNamedRefsParams.RetrieveOptions	OMIT	Constant to not retrieve any information (omit tags or branches).

Method Summary

Modifier and Type	Method	Description
static org.projectnessie.versioned.ImmutableRetrieveOptions.Builder	builder()
default boolean	isComputeAheadBehind()	Whether to compute ReferenceInfo.getAheadBehind(), requires a non-null GetNamedRefsParams.getBaseReference(), defaults to false.
default boolean	isComputeCommonAncestor()	Whether to identify the common ancestor on the default branch, defaults to false.
default boolean	isRetrieve()	Whether to retrieve the reference information at all, defaults to true.
default boolean	isRetrieveCommitMetaForHead()	Whether to retrieve the commit-meta information of each reference's HEAD commit in ReferenceInfo.getHeadCommitMeta(), defaults to false.

Field Details

OMIT

static final GetNamedRefsParams.RetrieveOptions OMIT

Constant to not retrieve any information (omit tags or branches).

BARE

static final GetNamedRefsParams.RetrieveOptions BARE

Constant to retrieve only the HEAD commit hash.

COMMIT_META

static final GetNamedRefsParams.RetrieveOptions COMMIT_META

Constant to retrieve the HEAD commit hash plus the commit-meta of the HEAD commit.

BASE_REFERENCE_RELATED_AND_COMMIT_META

static final GetNamedRefsParams.RetrieveOptions BASE_REFERENCE_RELATED_AND_COMMIT_META

Constant to retrieve the HEAD commit hash, the commit-meta of the HEAD commit, the common-ancestor to the base reference and the commits ahead and behind relative to the base reference.

Method Details

builder

static org.projectnessie.versioned.ImmutableRetrieveOptions.Builder builder()

isRetrieve

@Default
default boolean isRetrieve()

Whether to retrieve the reference information at all, defaults to true.

isComputeAheadBehind

@Default
default boolean isComputeAheadBehind()

Whether to compute ReferenceInfo.getAheadBehind(), requires a non-null GetNamedRefsParams.getBaseReference(), defaults to false.

isComputeCommonAncestor

@Default
default boolean isComputeCommonAncestor()

Whether to identify the common ancestor on the default branch, defaults to false.

isRetrieveCommitMetaForHead

@Default
default boolean isRetrieveCommitMetaForHead()

Whether to retrieve the commit-meta information of each reference's HEAD commit in ReferenceInfo.getHeadCommitMeta(), defaults to false.