Package org.projectnessie.model

Class ImmutableDetached

java.lang.Object

org.projectnessie.model.ImmutableDetached

All Implemented Interfaces:

Base, Detached, Reference

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableDetached
extends Object
implements Detached

Immutable implementation of Detached.

Use the builder to create immutable instances: ImmutableDetached.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImmutableDetached.Builder	Builds instances of type ImmutableDetached.

Nested classes/interfaces inherited from interface org.projectnessie.model.Reference

Reference.ReferenceType

Field Summary

Fields inherited from interface org.projectnessie.model.Detached

REF_NAME

Method Summary

Modifier and Type	Method	Description
static ImmutableDetached.Builder	builder()	Creates a builder for ImmutableDetached.
static ImmutableDetached	copyOf(Detached instance)	Creates an immutable copy of a Detached value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableDetached that have equal attribute values.
String	getHash()	backend system id.
ReferenceMetadata	getMetadata()	Returns a ReferenceMetadata instance that contains additional metadata about this reference.
int	hashCode()	Computes a hash code from attributes: metadata, hash.
String	toString()	Prints the immutable value Detached with attribute values.
ImmutableDetached	withHash(String value)	Copy the current immutable object by setting a value for the hash attribute.
ImmutableDetached	withMetadata(ReferenceMetadata value)	Copy the current immutable object by setting a value for the metadata attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.projectnessie.model.Detached

checkHash, getName, getType

Method Detail

getMetadata

@Nullable
public 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.

Specified by:

getMetadata in interface Reference

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.

getHash

public String getHash()

Description copied from interface: Reference

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

Specified by:

getHash in interface Detached

Specified by:

getHash in interface Reference

Returns:

The value of the hash attribute

withMetadata

public final ImmutableDetached withMetadata(@Nullable
                                            ReferenceMetadata value)

Copy the current immutable object by setting a value for the metadata attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for metadata (can be null)

Returns:

A modified copy of the this object

withHash

public final ImmutableDetached withHash(String value)

Copy the current immutable object by setting a value for the hash attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for hash

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableDetached that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: metadata, hash.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Detached with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableDetached copyOf(Detached instance)

Creates an immutable copy of a Detached value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable Detached instance

builder

public static ImmutableDetached.Builder builder()

Creates a builder for ImmutableDetached.

 ImmutableDetached.builder()
    .metadata(org.projectnessie.model.ReferenceMetadata | null) // nullable metadata
    .hash(String) // required hash
    .build();
 

Returns:

A new ImmutableDetached builder