Package com.spotify.github.v3.search

Class ImmutableSearchUsers

java.lang.Object

com.spotify.github.v3.search.ImmutableSearchUsers

All Implemented Interfaces:

Search, SearchUsers

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

Immutable implementation of SearchUsers.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableSearchUsers.Builder	builder()	Creates a builder for ImmutableSearchUsers.
static ImmutableSearchUsers	copyOf(SearchUsers instance)	Creates an immutable copy of a SearchUsers value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableSearchUsers that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: totalCount, incompleteResults, items.
Boolean	incompleteResults()	Are returned results incomplete
List<User>	items()	Users search results
String	toString()	Prints the immutable value SearchUsers with attribute values.
Integer	totalCount()	Total count of search hits
ImmutableSearchUsers	withIncompleteResults(Boolean value)	Copy the current immutable object by setting a value for the incompleteResults attribute.
ImmutableSearchUsers	withItems(User... elements)	Copy the current immutable object with elements that replace the content of items.
ImmutableSearchUsers	withItems(Iterable<? extends User> elements)	Copy the current immutable object with elements that replace the content of items.
ImmutableSearchUsers	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

items

@Nullable
public List<User> items()

Users search results

Specified by:

items in interface SearchUsers

withTotalCount

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

withItems

public final ImmutableSearchUsers withItems(@Nullable
                                            User... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withItems

public final ImmutableSearchUsers withItems(@Nullable
                                            Iterable<? extends User> elements)

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

Parameters:

elements - An iterable of items 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 ImmutableSearchUsers 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, items.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SearchUsers with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableSearchUsers copyOf(SearchUsers instance)

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

builder

public static ImmutableSearchUsers.Builder builder()

Creates a builder for ImmutableSearchUsers.

 ImmutableSearchUsers.builder()
    .totalCount(Integer | null) // nullable totalCount
    .incompleteResults(Boolean | null) // nullable incompleteResults
    .items(List<com.spotify.github.v3.User> | null) // nullable items
    .build();
 

Returns:

A new ImmutableSearchUsers builder