Package com.spotify.github.v3.search

Class ImmutableSearch

java.lang.Object

com.spotify.github.v3.search.ImmutableSearch

All Implemented Interfaces:

Search

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

Immutable implementation of Search.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableSearch.Builder	builder()	Creates a builder for ImmutableSearch.
static ImmutableSearch	copyOf(Search instance)	Creates an immutable copy of a Search value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableSearch that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: totalCount, incompleteResults.
Boolean	incompleteResults()	Are returned results incomplete
String	toString()	Prints the immutable value Search with attribute values.
Integer	totalCount()	Total count of search hits
ImmutableSearch	withIncompleteResults(Boolean value)	Copy the current immutable object by setting a value for the incompleteResults attribute.
ImmutableSearch	withTotalCount(Integer value)	Copy the current immutable object by setting a value for the totalCount attribute.

Methods inherited from class java.lang.Object

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

Method Detail

totalCount

@Nullable
public Integer totalCount()

Total count of search hits

Specified by:

totalCount in interface Search

incompleteResults

@Nullable
public Boolean incompleteResults()

Are returned results incomplete

Specified by:

incompleteResults in interface Search

withTotalCount

public final ImmutableSearch withTotalCount(@Nullable
                                            Integer value)

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

Parameters:

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

Returns:

A modified copy of the this object

withIncompleteResults

public final ImmutableSearch withIncompleteResults(@Nullable
                                                   Boolean value)

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

Parameters:

value - A new value for incompleteResults (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 ImmutableSearch 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: totalCount, incompleteResults.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Search with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableSearch copyOf(Search instance)

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

builder

public static ImmutableSearch.Builder builder()

Creates a builder for ImmutableSearch.

 ImmutableSearch.builder()
    .totalCount(Integer | null) // nullable totalCount
    .incompleteResults(Boolean | null) // nullable incompleteResults
    .build();
 

Returns:

A new ImmutableSearch builder