de.flapdoodle.formula

Class ImmutableValueContainer

java.lang.Object

de.flapdoodle.formula.ValueContainer

de.flapdoodle.formula.ImmutableValueContainer

@ParametersAreNonnullByDefault
 @Generated(value="org.immutables.processor.ProxyProcessor")
 @Immutable
 @CheckReturnValue
public final class ImmutableValueContainer
extends ValueContainer

Immutable implementation of ValueContainer.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableValueContainer.Builder	builder() Creates a builder for ImmutableValueContainer.
static ImmutableValueContainer	copyOf(ValueContainer instance) Creates an immutable copy of a ValueContainer value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableValueContainer that have equal attribute values.
int	hashCode() Computes a hash code from attributes: values, nullValues.
protected com.google.common.collect.ImmutableSet<Value<?>>	nullValues()
String	toString() Prints the immutable value ValueContainer with attribute values.
protected com.google.common.collect.ImmutableMap<Value<?>,Object>	values()
ImmutableValueContainer	withNullValues(Iterable<? extends Value<?>> elements) Copy the current immutable object with elements that replace the content of nullValues.
ImmutableValueContainer	withNullValues(Value<?>... elements) Copy the current immutable object with elements that replace the content of nullValues.
ImmutableValueContainer	withValues(Map<? extends Value<?>,? extends Object> entries) Copy the current immutable object by replacing the values map with the specified map.

Methods inherited from class de.flapdoodle.formula.ValueContainer

add, empty, get, keys

Methods inherited from class java.lang.Object

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

Method Detail

values

protected com.google.common.collect.ImmutableMap<Value<?>,Object> values()

Specified by:

values in class ValueContainer

Returns:

The value of the values attribute

nullValues

protected com.google.common.collect.ImmutableSet<Value<?>> nullValues()

Specified by:

nullValues in class ValueContainer

Returns:

The value of the nullValues attribute

withValues

public final ImmutableValueContainer withValues(Map<? extends Value<?>,? extends Object> entries)

Copy the current immutable object by replacing the values map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

entries - The entries to be added to the values map

Returns:

A modified copy of this object

withNullValues

@SafeVarargs
public final ImmutableValueContainer withNullValues(Value<?>... elements)

Copy the current immutable object with elements that replace the content of nullValues.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withNullValues

public final ImmutableValueContainer withNullValues(Iterable<? extends Value<?>> elements)

Copy the current immutable object with elements that replace the content of nullValues. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of nullValues elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableValueContainer 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: values, nullValues.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ValueContainer with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static ImmutableValueContainer copyOf(ValueContainer instance)

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

builder

public static ImmutableValueContainer.Builder builder()

Creates a builder for ImmutableValueContainer.

 ImmutableValueContainer.builder()
    .putValues|putAllValues(de.flapdoodle.formula.Value<?> => Object) // values mappings
    .addNullValues|addAllNullValues(de.flapdoodle.formula.Value<?>) // nullValues elements
    .build();
 

Returns:

A new ImmutableValueContainer builder