de.flapdoodle.collections

Class GeneratedImmutableTypedMap<K>

java.lang.Object

de.flapdoodle.collections.ImmutableTypedMap<K>

de.flapdoodle.collections.GeneratedImmutableTypedMap<K>

All Implemented Interfaces:

TypedMap<K>

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class GeneratedImmutableTypedMap<K>
extends ImmutableTypedMap<K>

Immutable implementation of ImmutableTypedMap.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeneratedImmutableTypedMap.Builder<K> Builds instances of type GeneratedImmutableTypedMap.

Method Summary

Modifier and Type	Method and Description
static <K> GeneratedImmutableTypedMap.Builder<K>	builder() Creates a builder for GeneratedImmutableTypedMap.
static <K> GeneratedImmutableTypedMap<K>	copyOf(ImmutableTypedMap<K> instance) Creates an immutable copy of a ImmutableTypedMap value.
boolean	equals(Object another) This instance is equal to all instances of GeneratedImmutableTypedMap that have equal attribute values.
int	hashCode() Computes a hash code from attributes: map.
Set<Pair<K,? extends TypeInfo<?>>>	keySet() Returns a lazily initialized value of the keySet attribute.
protected Map<Pair<K,? extends TypeInfo<?>>,Object>	map()
String	toString() Prints the immutable value ImmutableTypedMap with attribute values.
GeneratedImmutableTypedMap<K>	withMap(Map<? extends Pair<K,? extends TypeInfo<?>>,? extends Object> entries) Copy the current immutable object by replacing the map map with the specified map.

Methods inherited from class de.flapdoodle.collections.ImmutableTypedMap

add, addAll, asMutable, copyOf, empty, get, of, of

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.collections.TypedMap

immutable, mutable

Method Detail

map

protected Map<Pair<K,? extends TypeInfo<?>>,Object> map()

Specified by:

map in class ImmutableTypedMap<K>

Returns:

The value of the map attribute

withMap

public final GeneratedImmutableTypedMap<K> withMap(Map<? extends Pair<K,? extends TypeInfo<?>>,? extends Object> entries)

Copy the current immutable object by replacing the map 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 map map

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of GeneratedImmutableTypedMap 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: map.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value ImmutableTypedMap with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

keySet

public Set<Pair<K,? extends TypeInfo<?>>> keySet()

Returns a lazily initialized value of the keySet attribute. Initialized once and only once and stored for subsequent access with proper synchronization. In case of any exception or error thrown by the lazy value initializer, the result will not be memoised (i.e. remembered) and on next call computation will be attempted again.

Specified by:

keySet in interface TypedMap<K>

Overrides:

keySet in class ImmutableTypedMap<K>

Returns:

A lazily initialized value of the keySet attribute

copyOf

public static <K> GeneratedImmutableTypedMap<K> copyOf(ImmutableTypedMap<K> instance)

Creates an immutable copy of a ImmutableTypedMap value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

K - generic parameter K

Parameters:

instance - The instance to copy

Returns:

A copied immutable ImmutableTypedMap instance

builder

public static <K> GeneratedImmutableTypedMap.Builder<K> builder()

Creates a builder for GeneratedImmutableTypedMap.

 GeneratedImmutableTypedMap.<K>builder()
    .putMap|putAllMap(de.flapdoodle.types.Pair<K, ? extends de.flapdoodle.reflection.TypeInfo<?>> => Object) // map mappings
    .build();
 

Type Parameters:

K - generic parameter K

Returns:

A new GeneratedImmutableTypedMap builder