com.orbitz.consul.option

Class ImmutableQueryOptions

java.lang.Object

com.orbitz.consul.option.QueryOptions

com.orbitz.consul.option.ImmutableQueryOptions

All Implemented Interfaces:

ParamAdder

@Generated(value={"Immutables.generator","QueryOptions"})
public final class ImmutableQueryOptions
extends QueryOptions

Immutable implementation of QueryOptions.

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.orbitz.consul.option.QueryOptions

BLANK

Method Summary

Modifier and Type	Method and Description
static ImmutableQueryOptions.Builder	builder() Creates a builder for ImmutableQueryOptions.
static ImmutableQueryOptions	copyOf(QueryOptions instance) Creates an immutable copy of a QueryOptions value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableQueryOptions that have equal attribute values.
ConsistencyMode	getConsistencyMode()
com.google.common.base.Optional<BigInteger>	getIndex()
com.google.common.base.Optional<String>	getNear()
com.google.common.base.Optional<String>	getToken()
com.google.common.base.Optional<String>	getWait()
int	hashCode() Computes a hash code from attributes: wait, token, index, near, consistencyMode, isBlocking, hasToken.
boolean	hasToken()
boolean	isBlocking()
String	toString() Prints the immutable value QueryOptions with attribute values.
ImmutableQueryOptions	withConsistencyMode(ConsistencyMode value) Copy the current immutable object by setting a value for the consistencyMode attribute.
ImmutableQueryOptions	withIndex(BigInteger value) Copy the current immutable object by setting a present value for the optional index attribute.
ImmutableQueryOptions	withIndex(com.google.common.base.Optional<BigInteger> optional) Copy the current immutable object by setting an optional value for the index attribute.
ImmutableQueryOptions	withNear(com.google.common.base.Optional<String> optional) Copy the current immutable object by setting an optional value for the near attribute.
ImmutableQueryOptions	withNear(String value) Copy the current immutable object by setting a present value for the optional near attribute.
ImmutableQueryOptions	withToken(com.google.common.base.Optional<String> optional) Copy the current immutable object by setting an optional value for the token attribute.
ImmutableQueryOptions	withToken(String value) Copy the current immutable object by setting a present value for the optional token attribute.
ImmutableQueryOptions	withWait(com.google.common.base.Optional<String> optional) Copy the current immutable object by setting an optional value for the wait attribute.
ImmutableQueryOptions	withWait(String value) Copy the current immutable object by setting a present value for the optional wait attribute.

Methods inherited from class com.orbitz.consul.option.QueryOptions

blockMinutes, blockSeconds, toQuery

Methods inherited from class java.lang.Object

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

Method Detail

getWait

public com.google.common.base.Optional<String> getWait()

Specified by:

getWait in class QueryOptions

Returns:

The value of the wait attribute

getToken

public com.google.common.base.Optional<String> getToken()

Specified by:

getToken in class QueryOptions

Returns:

The value of the token attribute

getIndex

public com.google.common.base.Optional<BigInteger> getIndex()

Specified by:

getIndex in class QueryOptions

Returns:

The value of the index attribute

getNear

public com.google.common.base.Optional<String> getNear()

Specified by:

getNear in class QueryOptions

Returns:

The value of the near attribute

getConsistencyMode

public ConsistencyMode getConsistencyMode()

Overrides:

getConsistencyMode in class QueryOptions

Returns:

The value of the consistencyMode attribute

isBlocking

public boolean isBlocking()

Overrides:

isBlocking in class QueryOptions

Returns:

The computed-at-construction value of the isBlocking attribute

hasToken

public boolean hasToken()

Overrides:

hasToken in class QueryOptions

Returns:

The computed-at-construction value of the hasToken attribute

withWait

public final ImmutableQueryOptions withWait(String value)

Copy the current immutable object by setting a present value for the optional wait attribute.

Parameters:

value - The value for wait

Returns:

A modified copy of this object

withWait

public final ImmutableQueryOptions withWait(com.google.common.base.Optional<String> optional)

Copy the current immutable object by setting an optional value for the wait attribute. An equality check is used to prevent copying of the same value by returning this.

Parameters:

optional - A value for wait

Returns:

A modified copy of this object

withToken

public final ImmutableQueryOptions withToken(String value)

Copy the current immutable object by setting a present value for the optional token attribute.

Parameters:

value - The value for token

Returns:

A modified copy of this object

withToken

public final ImmutableQueryOptions withToken(com.google.common.base.Optional<String> optional)

Copy the current immutable object by setting an optional value for the token attribute. An equality check is used to prevent copying of the same value by returning this.

Parameters:

optional - A value for token

Returns:

A modified copy of this object

withIndex

public final ImmutableQueryOptions withIndex(BigInteger value)

Copy the current immutable object by setting a present value for the optional index attribute.

Parameters:

value - The value for index

Returns:

A modified copy of this object

withIndex

public final ImmutableQueryOptions withIndex(com.google.common.base.Optional<BigInteger> optional)

Copy the current immutable object by setting an optional value for the index attribute. A shallow reference equality check on the optional value is used to prevent copying of the same value by returning this.

Parameters:

optional - A value for index

Returns:

A modified copy of this object

withNear

public final ImmutableQueryOptions withNear(String value)

Copy the current immutable object by setting a present value for the optional near attribute.

Parameters:

value - The value for near

Returns:

A modified copy of this object

withNear

public final ImmutableQueryOptions withNear(com.google.common.base.Optional<String> optional)

Copy the current immutable object by setting an optional value for the near attribute. An equality check is used to prevent copying of the same value by returning this.

Parameters:

optional - A value for near

Returns:

A modified copy of this object

withConsistencyMode

public final ImmutableQueryOptions withConsistencyMode(ConsistencyMode value)

Copy the current immutable object by setting a value for the consistencyMode attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for consistencyMode

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableQueryOptions 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: wait, token, index, near, consistencyMode, isBlocking, hasToken.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value QueryOptions with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableQueryOptions copyOf(QueryOptions instance)

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

builder

public static ImmutableQueryOptions.Builder builder()

Creates a builder for ImmutableQueryOptions.

Returns:

A new ImmutableQueryOptions builder