Package org.projectnessie.model

Interface Reference

All Superinterfaces:

Base

All Known Subinterfaces:

Branch, Tag

All Known Implementing Classes:

ImmutableBranch, ImmutableTag

public interface Reference
extends Base

Method Summary

Modifier and Type	Method	Description
default void	checkHash()	Validation rule using Validation.validateHash(String).
@Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") String	getHash()	backend system id.
ReferenceMetadata	getMetadata()	Returns a ReferenceMetadata instance that contains additional metadata about this reference.
@NotBlank @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String	getName()	Human-readable reference name.

Method Detail

getName

@NotBlank
@Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",
         message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..")
@NotBlank @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String getName()

Human-readable reference name.

getHash

@Nullable
@Pattern(regexp="^[0-9a-fA-F]{16,64}$",
         message="Hash must consist of the hex representation of 8-32 bytes")
@Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") String getHash()

backend system id. Usually the 32-byte hash of the commit this reference points to.

checkHash

@Check
default void checkHash()

Validation rule using Validation.validateHash(String).

getMetadata

@Nullable
ReferenceMetadata getMetadata()

Returns a ReferenceMetadata instance that contains additional metadata about this reference. Note that this is only added by the server when explicitly requested by the client.

Returns:

A ReferenceMetadata instance that contains additional metadata about this reference. Note that this is only added by the server when explicitly requested by the client.