Package org.projectnessie.model

Class ImmutableReferencesResponse

java.lang.Object

org.projectnessie.model.ImmutableReferencesResponse

All Implemented Interfaces:

PaginatedResponse, ReferencesResponse

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

Immutable implementation of ReferencesResponse.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableReferencesResponse.Builder	builder()	Creates a builder for ImmutableReferencesResponse.
static ImmutableReferencesResponse	copyOf(ReferencesResponse instance)	Creates an immutable copy of a ReferencesResponse value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableReferencesResponse that have equal attribute values.
List<Reference>	getReferences()
String	getToken()	Pass this value to the next invocation of the API function to get the next page of results.
int	hashCode()	Computes a hash code from attributes: isHasMore, token, references.
boolean	isHasMore()	Whether there are more result-items than returned by this response object.
String	toString()	Prints the immutable value ReferencesResponse with attribute values.
ImmutableReferencesResponse	withIsHasMore(boolean value)	Copy the current immutable object by setting a value for the isHasMore attribute.
ImmutableReferencesResponse	withReferences(Iterable<? extends Reference> elements)	Copy the current immutable object with elements that replace the content of references.
ImmutableReferencesResponse	withReferences(Reference... elements)	Copy the current immutable object with elements that replace the content of references.
ImmutableReferencesResponse	withToken(String value)	Copy the current immutable object by setting a value for the token attribute.

Methods inherited from class java.lang.Object

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

Method Detail

isHasMore

public boolean isHasMore()

Whether there are more result-items than returned by this response object.

If there are more result-items, the value returned by getToken() can be used in the next invocation to get the next "page" of results.

Specified by:

isHasMore in interface PaginatedResponse

Returns:

true, if there are more result items.

getToken

@Nullable
public String getToken()

Pass this value to the next invocation of the API function to get the next page of results.

Paging tokens are opaque and the structure may change without prior notice even in patch releases.

Specified by:

getToken in interface PaginatedResponse

Returns:

paging continuation token for the next invocation of an API function taking a subclass of AbstractParams, if isHasMore() is true. Undefined, if isHasMore() is false.

getReferences

public List<Reference> getReferences()

Specified by:

getReferences in interface ReferencesResponse

Returns:

The value of the references attribute

withIsHasMore

public final ImmutableReferencesResponse withIsHasMore(boolean value)

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

Parameters:

value - A new value for isHasMore

Returns:

A modified copy of the this object

withToken

public final ImmutableReferencesResponse withToken(@Nullable
                                                   String value)

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

Parameters:

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

Returns:

A modified copy of the this object

withReferences

public final ImmutableReferencesResponse withReferences(Reference... elements)

Copy the current immutable object with elements that replace the content of references.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withReferences

public final ImmutableReferencesResponse withReferences(Iterable<? extends Reference> elements)

Copy the current immutable object with elements that replace the content of references. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of references elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableReferencesResponse 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: isHasMore, token, references.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ReferencesResponse with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableReferencesResponse copyOf(ReferencesResponse instance)

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

builder

public static ImmutableReferencesResponse.Builder builder()

Creates a builder for ImmutableReferencesResponse.

 ImmutableReferencesResponse.builder()
    .isHasMore(boolean) // optional isHasMore
    .token(String | null) // nullable token
    .addReferences|addAllReferences(org.projectnessie.model.Reference) // references elements
    .build();
 

Returns:

A new ImmutableReferencesResponse builder