org.spongepowered.api.data.value.immutable

Interface ImmutableMapValue<K,V>

Type Parameters:

K - The type of the key

V - The type of the value

All Superinterfaces:

BaseValue<Map<K,V>>, ImmutableValue<Map<K,V>>

public interface ImmutableMapValue<K,V>
extends ImmutableValue<Map<K,V>>

Represents a specialized type of ImmutableValue that is different from an ImmutableCollectionValue 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".

Method Summary

Modifier and Type	Method and Description
MapValue<K,V>	asMutable() Creates a mutable Value for this ImmutableValue.
boolean	containsKey(K key) Checks if the provided key is contained within this map.
boolean	containsValue(V value) Checks if the provided value is contained within this map.
ImmutableSet<Map.Entry<K,V>>	entrySet() Retrieves an ImmutableSet of the Map.Entrys contained within this map value.
ImmutableSet<K>	keySet() Gets an ImmutableSet of all keys contained in this map value.
int	size() Gets the size of this map.
ImmutableMapValue<K,V>	transform(Function<Map<K,V>,Map<K,V>> function) Retrieves the underlying value for this ImmutableValue and applies the given Function onto that value, after which, the product is sent to a new ImmutableValue replacing this one.
ImmutableCollection<V>	values() Retrieves an ImmutableCollection of all available values within this map.
ImmutableMapValue<K,V>	with(K key, V value) Associates the provided key to the provided value in the new map.
ImmutableMapValue<K,V>	with(Map<K,V> value) Creates a new ImmutableValue 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 ImmutableValue.
ImmutableMapValue<K,V>	withAll(Map<K,V> map) Associates all provided Map.Entry along with all pre-existing map entries in a new ImmutableMapValue.
ImmutableMapValue<K,V>	without(K key) Creates a new ImmutableMapValue without the provided key and the associated value.
ImmutableMapValue<K,V>	withoutAll(Iterable<K> keys) Creates a new ImmutableMapValue without the provided keys and their associated values.
ImmutableMapValue<K,V>	withoutAll(Predicate<Map.Entry<K,V>> predicate) Creates a new ImmutableMapValue 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.BaseValue

exists, get, getDefault, getDirect, getKey

Method Detail

size

int size()

Gets the size of this map.

Returns:

The size of this map

with

ImmutableMapValue<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

with

ImmutableMapValue<K,V> with(Map<K,V> value)

Description copied from interface: ImmutableValue

Creates a new ImmutableValue 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 ImmutableValue.

Specified by:

with in interface ImmutableValue<Map<K,V>>

Parameters:

value - The value to replace

Returns:

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

withAll

ImmutableMapValue<K,V> withAll(Map<K,V> map)

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

Parameters:

map - The map of key values to set

Returns:

The new value, for chaining

without

ImmutableMapValue<K,V> without(K key)

Creates a new ImmutableMapValue without the provided key and the associated value.

Parameters:

key - The key to exclude the association

Returns:

The new value, for chaining

withoutAll

ImmutableMapValue<K,V> withoutAll(Iterable<K> keys)

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

Parameters:

keys - The keys to exclude

Returns:

The new value, for chaining

withoutAll

ImmutableMapValue<K,V> withoutAll(Predicate<Map.Entry<K,V>> predicate)

Creates a new ImmutableMapValue 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

containsKey

boolean containsKey(K key)

Checks if the provided key is contained within this map.

Parameters:

key - The key to check

Returns:

True if the key is contained

containsValue

boolean containsValue(V value)

Checks if the provided value is contained within this map.

Parameters:

value - The value to check

Returns:

True if the value is contained

keySet

ImmutableSet<K> keySet()

Gets an ImmutableSet of all keys contained in this map value.

Returns:

The set of keys

entrySet

ImmutableSet<Map.Entry<K,V>> entrySet()

Retrieves an ImmutableSet of the Map.Entrys contained within this map value.

Returns:

The immutable set of entries

values

ImmutableCollection<V> values()

Retrieves an ImmutableCollection of all available values within this map.

Returns:

The collection of values

transform

ImmutableMapValue<K,V> transform(Function<Map<K,V>,Map<K,V>> function)

Description copied from interface: ImmutableValue

Retrieves the underlying value for this ImmutableValue and applies the given Function onto that value, after which, the product is sent to a new ImmutableValue 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 ImmutableValue<Map<K,V>>

Parameters:

function - The function to apply onto the existing value

Returns:

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

asMutable

MapValue<K,V> asMutable()

Description copied from interface: ImmutableValue

Creates a mutable Value for this ImmutableValue.

Specified by:

asMutable in interface ImmutableValue<Map<K,V>>

Returns:

A mutable value