com.orbitz.consul.option

Class ImmutableQueryOptions.Builder

java.lang.Object

com.orbitz.consul.option.ImmutableQueryOptions.Builder

Enclosing class:

ImmutableQueryOptions

public static final class ImmutableQueryOptions.Builder
extends Object

Builds instances of type ImmutableQueryOptions. 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 and Description
ImmutableQueryOptions	build() Builds a new ImmutableQueryOptions.
ImmutableQueryOptions.Builder	consistencyMode(ConsistencyMode consistencyMode) Initializes the value for the consistencyMode attribute.
ImmutableQueryOptions.Builder	from(QueryOptions instance) Fill a builder with attribute values from the provided QueryOptions instance.
ImmutableQueryOptions.Builder	index(BigInteger index) Initializes the optional value index to index.
ImmutableQueryOptions.Builder	index(com.google.common.base.Optional<BigInteger> index) Initializes the optional value index to index.
ImmutableQueryOptions.Builder	near(com.google.common.base.Optional<String> near) Initializes the optional value near to near.
ImmutableQueryOptions.Builder	near(String near) Initializes the optional value near to near.
ImmutableQueryOptions.Builder	token(com.google.common.base.Optional<String> token) Initializes the optional value token to token.
ImmutableQueryOptions.Builder	token(String token) Initializes the optional value token to token.
ImmutableQueryOptions.Builder	wait(com.google.common.base.Optional<String> wait) Initializes the optional value wait to wait.
ImmutableQueryOptions.Builder	wait(String wait) Initializes the optional value wait to wait.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableQueryOptions.Builder from(QueryOptions instance)

Fill a builder with attribute values from the provided QueryOptions 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

wait

public final ImmutableQueryOptions.Builder wait(String wait)

Initializes the optional value wait to wait.

Parameters:

wait - The value for wait

Returns:

this builder for chained invocation

wait

public final ImmutableQueryOptions.Builder wait(com.google.common.base.Optional<String> wait)

Initializes the optional value wait to wait.

Parameters:

wait - The value for wait

Returns:

this builder for use in a chained invocation

token

public final ImmutableQueryOptions.Builder token(String token)

Initializes the optional value token to token.

Parameters:

token - The value for token

Returns:

this builder for chained invocation

token

public final ImmutableQueryOptions.Builder token(com.google.common.base.Optional<String> token)

Initializes the optional value token to token.

Parameters:

token - The value for token

Returns:

this builder for use in a chained invocation

index

public final ImmutableQueryOptions.Builder index(BigInteger index)

Initializes the optional value index to index.

Parameters:

index - The value for index

Returns:

this builder for chained invocation

index

public final ImmutableQueryOptions.Builder index(com.google.common.base.Optional<BigInteger> index)

Initializes the optional value index to index.

Parameters:

index - The value for index

Returns:

this builder for use in a chained invocation

near

public final ImmutableQueryOptions.Builder near(String near)

Initializes the optional value near to near.

Parameters:

near - The value for near

Returns:

this builder for chained invocation

near

public final ImmutableQueryOptions.Builder near(com.google.common.base.Optional<String> near)

Initializes the optional value near to near.

Parameters:

near - The value for near

Returns:

this builder for use in a chained invocation

consistencyMode

public final ImmutableQueryOptions.Builder consistencyMode(ConsistencyMode consistencyMode)

Initializes the value for the consistencyMode attribute.

If not set, this attribute will have a default value as returned by the initializer of consistencyMode.

Parameters:

consistencyMode - The value for consistencyMode

Returns:

this builder for use in a chained invocation

build

public ImmutableQueryOptions build()

Builds a new ImmutableQueryOptions.

Returns:

An immutable instance of QueryOptions

Throws:

IllegalStateException - if any required attributes are missing