Package org.projectnessie.model

Class ImmutableBranch

java.lang.Object

org.projectnessie.model.ImmutableBranch

All Implemented Interfaces:

Base, Branch, Reference

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

Immutable implementation of Branch.

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.projectnessie.model.Branch

checkName

Methods inherited from interface org.projectnessie.model.Reference

checkHash

Method Detail

getName

public String getName()

Human-readable reference name.

Specified by:

getName in interface Reference

getHash

@Nullable
public String getHash()

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

Specified by:

getHash in interface Reference

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.

withName

public final ImmutableBranch withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withHash

public final ImmutableBranch withHash(@Nullable
                                      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 (can be null)

Returns:

A modified copy of the this object

withMetadata

public final ImmutableBranch 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

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableBranch 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: name, hash, metadata.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Branch with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableBranch copyOf(Branch instance)

Creates an immutable copy of a Branch 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 Branch instance

builder

public static ImmutableBranch.Builder builder()

Creates a builder for ImmutableBranch.

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

Returns:

A new ImmutableBranch builder