ImmutableValue (consul-client 1.1.0 API)

java.lang.Object
- com.orbitz.consul.model.kv.Value
- - com.orbitz.consul.model.kv.ImmutableValue

@ParametersAreNonnullByDefault
 @Generated(value={"Immutables.generator","Value"})
 @Immutable
public final class ImmutableValue
extends Value

Immutable implementation of Value.

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableValue.Builder
Builds instances of type ImmutableValue.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableValue.Builder` Builds instances of type `ImmutableValue`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableValue.Builder`	`builder()` Creates a builder for `ImmutableValue`.
`static ImmutableValue`	`copyOf(Value instance)` Creates an immutable copy of a `Value` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableValue` that have equal attribute values.
`long`	`getCreateIndex()`
`long`	`getFlags()`
`String`	`getKey()`
`long`	`getLockIndex()`
`long`	`getModifyIndex()`
`Optional<String>`	`getSession()`
`Optional<String>`	`getValue()`
`Optional<String>`	`getValueAsString()`
`int`	`hashCode()` Computes a hash code from attributes: `createIndex`, `modifyIndex`, `lockIndex`, `key`, `flags`, `value`, `session`.
`String`	`toString()` Prints the immutable value `Value` with attribute values.
`ImmutableValue`	`withCreateIndex(long value)` Copy the current immutable object by setting a value for the `createIndex` attribute.
`ImmutableValue`	`withFlags(long value)` Copy the current immutable object by setting a value for the `flags` attribute.
`ImmutableValue`	`withKey(String value)` Copy the current immutable object by setting a value for the `key` attribute.
`ImmutableValue`	`withLockIndex(long value)` Copy the current immutable object by setting a value for the `lockIndex` attribute.
`ImmutableValue`	`withModifyIndex(long value)` Copy the current immutable object by setting a value for the `modifyIndex` attribute.
`ImmutableValue`	`withSession(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `session` attribute.
`ImmutableValue`	`withSession(String value)` Copy the current immutable object by setting a present value for the optional `session` attribute.
`ImmutableValue`	`withValue(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `value` attribute.
`ImmutableValue`	`withValue(String value)` Copy the current immutable object by setting a present value for the optional `value` attribute.

Methods inherited from class com.orbitz.consul.model.kv.Value
getValueAsString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getCreateIndex
```
public long getCreateIndex()
```
    Specified by:
    
    getCreateIndex in class Value
    
    Returns:
    
    The value of the createIndex attribute
  - getModifyIndex
```
public long getModifyIndex()
```
    Specified by:
    
    getModifyIndex in class Value
    
    Returns:
    
    The value of the modifyIndex attribute
  - getLockIndex
```
public long getLockIndex()
```
    Specified by:
    
    getLockIndex in class Value
    
    Returns:
    
    The value of the lockIndex attribute
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in class Value
    
    Returns:
    
    The value of the key attribute
  - getFlags
```
public long getFlags()
```
    Specified by:
    
    getFlags in class Value
    
    Returns:
    
    The value of the flags attribute
  - getValue
```
public Optional<String> getValue()
```
    Specified by:
    
    getValue in class Value
    
    Returns:
    
    The value of the value attribute
  - getSession
```
public Optional<String> getSession()
```
    Specified by:
    
    getSession in class Value
    
    Returns:
    
    The value of the session attribute
  - withCreateIndex
```
public final ImmutableValue withCreateIndex(long value)
```
    Copy the current immutable object by setting a value for the createIndex attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for createIndex
    
    Returns:
    
    A modified copy of the this object
  - withModifyIndex
```
public final ImmutableValue withModifyIndex(long value)
```
    Copy the current immutable object by setting a value for the modifyIndex attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for modifyIndex
    
    Returns:
    
    A modified copy of the this object
  - withLockIndex
```
public final ImmutableValue withLockIndex(long value)
```
    Copy the current immutable object by setting a value for the lockIndex attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for lockIndex
    
    Returns:
    
    A modified copy of the this object
  - withKey
```
public final ImmutableValue withKey(String value)
```
    Copy the current immutable object by setting a value for the key attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for key
    
    Returns:
    
    A modified copy of the this object
  - withFlags
```
public final ImmutableValue withFlags(long value)
```
    Copy the current immutable object by setting a value for the flags attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for flags
    
    Returns:
    
    A modified copy of the this object
  - withValue
```
public final ImmutableValue withValue(String value)
```
    Copy the current immutable object by setting a present value for the optional value attribute.
    
    Parameters:
    
    value - The value for value
    
    Returns:
    
    A modified copy of this object
  - withValue
```
public final ImmutableValue withValue(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the value attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for value
    
    Returns:
    
    A modified copy of this object
  - withSession
```
public final ImmutableValue withSession(String value)
```
    Copy the current immutable object by setting a present value for the optional session attribute.
    
    Parameters:
    
    value - The value for session
    
    Returns:
    
    A modified copy of this object
  - withSession
```
public final ImmutableValue withSession(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the session attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for session
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(@Nullable
                      Object another)
```
    This instance is equal to all instances of ImmutableValue 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: createIndex, modifyIndex, lockIndex, key, flags, value, session.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value Value with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - getValueAsString
```
public Optional<String> getValueAsString()
```
    Returns a lazily initialized value of the valueAsString attribute. Initialized once and only once and stored for subsequent access with proper synchronization.
    
    Overrides:
    
    getValueAsString in class Value
    
    Returns:
    
    A lazily initialized value of the l.name attribute
  - copyOf
```
public static ImmutableValue copyOf(Value instance)
```
    Creates an immutable copy of a Value 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 Value instance
  - builder
```
public static ImmutableValue.Builder builder()
```
    Creates a builder for ImmutableValue.
    
    Returns:
    
    A new ImmutableValue builder

Class ImmutableValue

Nested Class Summary

Method Summary

Methods inherited from class com.orbitz.consul.model.kv.Value

Methods inherited from class java.lang.Object

Method Detail

getCreateIndex

getModifyIndex

getLockIndex

getKey

getFlags

getValue

getSession

withCreateIndex

withModifyIndex

withLockIndex

withKey

withFlags

withValue

withValue

withSession

withSession

equals

hashCode

toString

getValueAsString

copyOf

builder