Package com.spotify.github.v3.search

Class ImmutableSearch.Builder

java.lang.Object

com.spotify.github.v3.search.ImmutableSearch.Builder

Enclosing class:

ImmutableSearch

@NotThreadSafe
public static final class ImmutableSearch.Builder
extends Object

Builds instances of type ImmutableSearch. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableSearch	build()	Builds a new ImmutableSearch.
ImmutableSearch.Builder	from(Search instance)	Fill a builder with attribute values from the provided Search instance.
ImmutableSearch.Builder	incompleteResults(Boolean incompleteResults)	Initializes the value for the incompleteResults attribute.
ImmutableSearch.Builder	totalCount(Integer totalCount)	Initializes the value for the totalCount attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

@CanIgnoreReturnValue
public final ImmutableSearch.Builder from(Search instance)

Fill a builder with attribute values from the provided Search instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

totalCount

@CanIgnoreReturnValue
public final ImmutableSearch.Builder totalCount(@Nullable
                                                Integer totalCount)

Initializes the value for the totalCount attribute.

Parameters:

totalCount - The value for totalCount (can be null)

Returns:

this builder for use in a chained invocation

incompleteResults

@CanIgnoreReturnValue
public final ImmutableSearch.Builder incompleteResults(@Nullable
                                                       Boolean incompleteResults)

Initializes the value for the incompleteResults attribute.

Parameters:

incompleteResults - The value for incompleteResults (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableSearch build()

Builds a new ImmutableSearch.

Returns:

An immutable instance of Search

Throws:

IllegalStateException - if any required attributes are missing