de.team33.patterns.collection.ceres

Interface Mapping.Setup<K,V,M extends Map<K,V>,S extends Mapping.Setup<K,V,M,S>>

Type Parameters:

K - The key type of the target instance.

V - The value type of the target instance.

M - The final type of the target instance, at least Map.

S - The final type of the Setup implementation.

All Superinterfaces:

Setup<M,S>

All Known Implementing Classes:

Mapping.Builder, Mapping.Charger

Enclosing class:

Mapping

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface Mapping.Setup<K,V,M extends Map<K,V>,S extends Mapping.Setup<K,V,M,S>>
extends Setup<M,S>

Utility interface to set up a target instance of Map.

Method Summary

Modifier and Type	Method and Description
default S	clear() Removes all pairs of key / value from the instance to be set up.
default S	put(K key, V value) Puts a pair of key / value to the instance to be set up.
default S	putAll(Map<? extends K,? extends V> origin) Puts multiple pairs of key / value to the instance to be set up.
default S	remove(Object key) Removes a pair of a given key and its associated value from the instance to be set up.

Methods inherited from interface de.team33.patterns.building.elara.Setup

setup

Method Detail

put

default S put(K key,
              V value)

Puts a pair of key / value to the instance to be set up.

Throws:

UnsupportedOperationException - if Map.put(Object, Object) is not supported by the instance to be set up.

NullPointerException - if the specified key or value is null and the instance to be set up does not permit null keys or values

ClassCastException - if the class of the specified key or value prevents it from being put into the instance to be set up (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of the specified key or value prevents it from being stored in the instance to be set up.

See Also:

Map.put(Object, Object), Mapping.put(Map, Object, Object)

remove

default S remove(Object key)

Removes a pair of a given key and its associated value from the instance to be set up.

Avoids an unnecessary ClassCastException or NullPointerException which might be caused by Map.remove(Object) when the instance to be set up does not support the requested key.

Throws:

UnsupportedOperationException - if Map.remove(Object) is not supported by the subject.

See Also:

Map.remove(Object), Mapping.remove(Map, Object)

putAll

default S putAll(Map<? extends K,? extends V> origin)

Puts multiple pairs of key / value to the instance to be set up.

If origin is null it will be treated as an empty Map.

Throws:

UnsupportedOperationException - if Map.putAll(Map) is not supported by the instance to be set up.

NullPointerException - if any of the specified keys or values are null and the instance to be set up does not permit null keys or values.

ClassCastException - if the class of any specified key or value prevents it from being put into the subject (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of any key or value in the specified origin prevents it from being stored in the subject.

See Also:

Map.putAll(Map), Mapping.putAll(Map, Map)

clear

default S clear()

Removes all pairs of key / value from the instance to be set up.

Throws:

UnsupportedOperationException - if Collection.clear() is not supported by the subject.

See Also:

Map.clear(), Mapping.clear(Map)