de.flapdoodle.reflection

Class ImmutableMapTypeInfo<K,V>

java.lang.Object

de.flapdoodle.reflection.MapTypeInfo<K,V>

de.flapdoodle.reflection.ImmutableMapTypeInfo<K,V>

All Implemented Interfaces:

TypeInfo<Map<K,V>>

@Generated(value="org.immutables.processor.ProxyProcessor")
public final class ImmutableMapTypeInfo<K,V>
extends MapTypeInfo<K,V>

Immutable implementation of MapTypeInfo.

Use the builder to create immutable instances: ImmutableMapTypeInfo.builder(). Use the static factory method to create immutable instances: ImmutableMapTypeInfo.of().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static <K,V> ImmutableMapTypeInfo.Builder<K,V>	builder() Creates a builder for ImmutableMapTypeInfo.
static <K,V> ImmutableMapTypeInfo<K,V>	copyOf(MapTypeInfo<K,V> instance) Creates an immutable copy of a MapTypeInfo value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableMapTypeInfo that have equal attribute values.
int	hashCode() Computes a hash code from attributes: key, value.
TypeInfo<K>	key()
static <K,V> ImmutableMapTypeInfo<K,V>	of(TypeInfo<K> key, TypeInfo<V> value) Construct a new immutable MapTypeInfo instance.
String	toString() Prints the immutable value MapTypeInfo with attribute values.
TypeInfo<V>	value()
ImmutableMapTypeInfo<K,V>	withKey(TypeInfo<K> value) Copy the current immutable object by setting a value for the key attribute.
ImmutableMapTypeInfo<K,V>	withValue(TypeInfo<V> value) Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class de.flapdoodle.reflection.MapTypeInfo

cast, isInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.reflection.TypeInfo

ifInstance, listOf, mapOf, of

Method Detail

key

public TypeInfo<K> key()

Specified by:

key in class MapTypeInfo<K,V>

Returns:

The value of the key attribute

value

public TypeInfo<V> value()

Specified by:

value in class MapTypeInfo<K,V>

Returns:

The value of the value attribute

withKey

public final ImmutableMapTypeInfo<K,V> withKey(TypeInfo<K> value)

Copy the current immutable object by setting a value for the key attribute. A shallow reference equality check is 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

withValue

public final ImmutableMapTypeInfo<K,V> withValue(TypeInfo<V> value)

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

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableMapTypeInfo 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: key, value.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value MapTypeInfo with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static <K,V> ImmutableMapTypeInfo<K,V> of(TypeInfo<K> key,
                                                 TypeInfo<V> value)

Construct a new immutable MapTypeInfo instance.

Type Parameters:

K - generic parameter K

V - generic parameter V

Parameters:

key - The value for the key attribute

value - The value for the value attribute

Returns:

An immutable MapTypeInfo instance

copyOf

public static <K,V> ImmutableMapTypeInfo<K,V> copyOf(MapTypeInfo<K,V> instance)

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

V - generic parameter V

Parameters:

instance - The instance to copy

Returns:

A copied immutable MapTypeInfo instance

builder

public static <K,V> ImmutableMapTypeInfo.Builder<K,V> builder()

Creates a builder for ImmutableMapTypeInfo.

 ImmutableMapTypeInfo.<K, V>builder()
    .key(de.flapdoodle.reflection.TypeInfo<K>) // required key
    .value(de.flapdoodle.reflection.TypeInfo<V>) // required value
    .build();
 

Type Parameters:

K - generic parameter K

V - generic parameter V

Returns:

A new ImmutableMapTypeInfo builder