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 ofSearchUsers
.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 typeImmutableSearchUsers
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ImmutableSearchUsers.Builder
builder()
Creates a builder forImmutableSearchUsers
.static ImmutableSearchUsers
copyOf(SearchUsers instance)
Creates an immutable copy of aSearchUsers
value.boolean
equals(Object another)
This instance is equal to all instances ofImmutableSearchUsers
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:totalCount
,incompleteResults
,items
.Boolean
incompleteResults()
Are returned results incompleteList<User>
items()
Users search resultsString
toString()
Prints the immutable valueSearchUsers
with attribute values.Integer
totalCount()
Total count of search hitsImmutableSearchUsers
withIncompleteResults(Boolean value)
Copy the current immutable object by setting a value for theincompleteResults
attribute.ImmutableSearchUsers
withItems(User... elements)
Copy the current immutable object with elements that replace the content ofitems
.ImmutableSearchUsers
withItems(Iterable<? extends User> elements)
Copy the current immutable object with elements that replace the content ofitems
.ImmutableSearchUsers
withTotalCount(Integer value)
Copy the current immutable object by setting a value for thetotalCount
attribute.
-
-
-
Method Detail
-
totalCount
@Nullable public Integer totalCount()
Total count of search hits- Specified by:
totalCount
in interfaceSearch
-
incompleteResults
@Nullable public Boolean incompleteResults()
Are returned results incomplete- Specified by:
incompleteResults
in interfaceSearch
-
items
@Nullable public List<User> items()
Users search results- Specified by:
items
in interfaceSearchUsers
-
withTotalCount
public final ImmutableSearchUsers withTotalCount(@Nullable Integer value)
Copy the current immutable object by setting a value for thetotalCount
attribute. An equals check used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for totalCount (can benull
)- 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 theincompleteResults
attribute. An equals check used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for incompleteResults (can benull
)- 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 ofitems
.- 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 ofitems
. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- 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 ofImmutableSearchUsers
that have equal attribute values.
-
hashCode
public int hashCode()
Computes a hash code from attributes:totalCount
,incompleteResults
,items
.
-
toString
public String toString()
Prints the immutable valueSearchUsers
with attribute values.
-
copyOf
public static ImmutableSearchUsers copyOf(SearchUsers instance)
Creates an immutable copy of aSearchUsers
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 forImmutableSearchUsers
.ImmutableSearchUsers.builder() .totalCount(Integer | null) // nullable
totalCount
.incompleteResults(Boolean | null) // nullableincompleteResults
.items(List<com.spotify.github.v3.User> | null) // nullableitems
.build();- Returns:
- A new ImmutableSearchUsers builder
-
-