Package org.spongepowered.api.data.value

Interface MapValue.Immutable<K,V>

Type Parameters:

K - The type of the key

V - The type of the value

All Superinterfaces:

MapValue<K,V>, Value<java.util.Map<K,V>>, Value.Immutable<java.util.Map<K,V>>

Enclosing interface:

MapValue<K,V>

public static interface MapValue.Immutable<K,V>
extends MapValue<K,V>, Value.Immutable<java.util.Map<K,V>>

Represents a specialized type of Value.Immutable that is different from an CollectionValue.Immutable such that the "elements" are Map.Entry. Usually, this type of value is used to represent a particular "type" of "key" that is associated to a particular "value".

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.value.MapValue

MapValue.Immutable<K,V>, MapValue.Mutable<K,V>

Nested classes/interfaces inherited from interface org.spongepowered.api.data.value.Value

Value.Factory, Value.Immutable<E>, Value.Mutable<E>

Method Summary

Modifier and Type	Method	Description
default MapValue.Immutable<K,V>	asImmutable()	Retrieves an immutable form of this value.
MapValue.Mutable<K,V>	asMutable()	Retrieves a mutable form of this value.
default MapValue.Mutable<K,V>	asMutableCopy()	Retrieves a copy in the mutable form of this value.
MapValue.Immutable<K,V>	transform(java.util.function.Function<java.util.Map<K,V>,java.util.Map<K,V>> function)	Retrieves the underlying value for this Value.Immutable and applies the given Function onto that value, after which, the product is sent to a new Value.Immutable replacing this one.
MapValue.Immutable<K,V>	with(java.util.Map<K,V> value)	Creates a new Value.Immutable with the given E typed value, such that if the owning ValueContainer is immutable, the ValueContainer too is recreated as a new instance with the new Value.Immutable.
MapValue.Immutable<K,V>	with(K key, V value)	Associates the provided key to the provided value in the new map.
MapValue.Immutable<K,V>	withAll(java.util.Map<K,V> map)	Associates all provided Map.Entry along with all pre-existing map entries in a new MapValue.Immutable.
MapValue.Immutable<K,V>	without(K key)	Creates a new MapValue.Immutable without the provided key and the associated value.
MapValue.Immutable<K,V>	withoutAll(java.lang.Iterable<K> keys)	Creates a new MapValue.Immutable without the provided keys and their associated values.
MapValue.Immutable<K,V>	withoutAll(java.util.function.Predicate<java.util.Map.Entry<K,V>> predicate)	Creates a new MapValue.Immutable such that all entries are filtered by the provided Predicate, any that return true are retained in the new value.

Methods inherited from interface org.spongepowered.api.data.value.MapValue

containsKey, containsValue, entrySet, key, keySet, size, values

Methods inherited from interface org.spongepowered.api.data.value.Value

get

Method Detail

with

MapValue.Immutable<K,V> with(K key,
                                   V value)

Associates the provided key to the provided value in the new map. If there already exists a value for the provided key, the value is replaced.

Parameters:

key - The key to associate to the value

value - The value associated with the key

Returns:

The new value, for chaining

withAll

MapValue.Immutable<K,V> withAll(java.util.Map<K,V> map)

Associates all provided Map.Entry along with all pre-existing map entries in a new MapValue.Immutable.

Parameters:

map - The map of key values to set

Returns:

The new value, for chaining

without

MapValue.Immutable<K,V> without(K key)

Creates a new MapValue.Immutable without the provided key and the associated value.

Parameters:

key - The key to exclude the association

Returns:

The new value, for chaining

withoutAll

MapValue.Immutable<K,V> withoutAll(java.lang.Iterable<K> keys)

Creates a new MapValue.Immutable without the provided keys and their associated values.

Parameters:

keys - The keys to exclude

Returns:

The new value, for chaining

withoutAll

MapValue.Immutable<K,V> withoutAll(java.util.function.Predicate<java.util.Map.Entry<K,V>> predicate)

Creates a new MapValue.Immutable such that all entries are filtered by the provided Predicate, any that return true are retained in the new value. Elements that return true from Predicate.test(Object) are kept, and those that return false are excluded.

Parameters:

predicate - The predicate to filter

Returns:

The new value, for chaining

with

MapValue.Immutable<K,V> with(java.util.Map<K,V> value)

Description copied from interface: Value.Immutable

Creates a new Value.Immutable with the given E typed value, such that if the owning ValueContainer is immutable, the ValueContainer too is recreated as a new instance with the new Value.Immutable.

Specified by:

with in interface Value.Immutable<K>

Parameters:

value - The value to replace

Returns:

The owning ValueContainer, a new instance if it too is immutable

transform

MapValue.Immutable<K,V> transform(java.util.function.Function<java.util.Map<K,V>,java.util.Map<K,V>> function)

Description copied from interface: Value.Immutable

Retrieves the underlying value for this Value.Immutable and applies the given Function onto that value, after which, the product is sent to a new Value.Immutable replacing this one.

If the ValueContainer too is immutable, a new instance of the ValueContainer may be created. If the ValueContainer is mutable, the same instance of the ValueContainer is retained.

Specified by:

transform in interface Value.Immutable<K>

Parameters:

function - The function to apply onto the existing value

Returns:

The owning ValueContainer, a new instance if it too is immutable

asMutable

MapValue.Mutable<K,V> asMutable()

Description copied from interface: Value

Retrieves a mutable form of this value. Due to the vague nature of the value itself, some cases can already provide a Value.Mutable instance where this would simply return itself. In other cases, where the retrieved value is an Value.Immutable instance, a new mutable value is created with the same key and values.

Specified by:

asMutable in interface MapValue<K,V>

Specified by:

asMutable in interface Value<K>

Specified by:

asMutable in interface Value.Immutable<K>

Returns:

A mutable value

asMutableCopy

default MapValue.Mutable<K,V> asMutableCopy()

Description copied from interface: Value

Retrieves a copy in the mutable form of this value. The new is created with the same key and values.

Specified by:

asMutableCopy in interface MapValue<K,V>

Specified by:

asMutableCopy in interface Value<K>

Specified by:

asMutableCopy in interface Value.Immutable<K>

Returns:

A mutable value

asImmutable

default MapValue.Immutable<K,V> asImmutable()

Description copied from interface: Value

Retrieves an immutable form of this value. Due to the vague nature of the value itself, some cases can already provide a Value.Immutable instance where this would simply return itself. In other cases, where the retrieved value is a Value.Mutable instance, a new immutable value is created with the same key and values.

Specified by:

asImmutable in interface MapValue<K,V>

Specified by:

asImmutable in interface Value<K>

Specified by:

asImmutable in interface Value.Immutable<K>

Returns:

An immutable value