org.spongepowered.api.data.value.mutable

Interface MapValue<K,V>

Type Parameters:

K - The type of the key

V - The type of the value

All Superinterfaces:

BaseValue<Map<K,V>>, Value<Map<K,V>>

public interface MapValue<K,V>
extends Value<Map<K,V>>

Represents a specialized type of Value that is different from a CollectionValue 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
ImmutableMapValue<K,V>	asImmutable() Gets the ImmutableValue version of this Value such that all data is duplicated across to the new 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.
MapValue<K,V>	copy() Makes an independent copy of this Value with the same initial data.
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.
MapValue<K,V>	put(K key, V value) Associates the provided key to the provided value.
MapValue<K,V>	putAll(Map<K,V> map) Associates all provided Map.Entry to this map value.
MapValue<K,V>	remove(K key) Removes the association of the provided key to the value currently associated.
MapValue<K,V>	removeAll(Iterable<K> keys) Removes all key value associations of the provided keys.
MapValue<K,V>	removeAll(Predicate<Map.Entry<K,V>> predicate) Applies the Predicate to all Map.Entry within this MapValue.
int	size() Gets the size of this map.
MapValue<K,V>	transform(Function<Map<K,V>,Map<K,V>> function) Attempts to transform the underlying value based on the provided Function such that the result of Function.apply(Object) will replace the underlying value.
ImmutableCollection<V>	values() Retrieves an ImmutableCollection of all available values within this map.

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

set

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

put

MapValue<K,V> put(K key,
                  V value)

Associates the provided key to the provided value. 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:

This map value, for chaining

putAll

MapValue<K,V> putAll(Map<K,V> map)

Associates all provided Map.Entry to this map value.

Parameters:

map - The map of key values to set

Returns:

This map value, for chaining

remove

MapValue<K,V> remove(K key)

Removes the association of the provided key to the value currently associated.

Parameters:

key - The key to remove

Returns:

This map value, for chaining

removeAll

MapValue<K,V> removeAll(Iterable<K> keys)

Removes all key value associations of the provided keys.

Parameters:

keys - The keys to remove

Returns:

This map value, for chaining

removeAll

MapValue<K,V> removeAll(Predicate<Map.Entry<K,V>> predicate)

Applies the Predicate to all Map.Entry within this MapValue. Any entries that are false will be removed from the map value.

Parameters:

predicate - The predicate to filer

Returns:

This map 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

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

Description copied from interface: Value

Attempts to transform the underlying value based on the provided Function such that the result of Function.apply(Object) will replace the underlying value.

Specified by:

transform in interface Value<Map<K,V>>

Parameters:

function - The function to apply on the existing value

Returns:

The owning ValueContainer

asImmutable

ImmutableMapValue<K,V> asImmutable()

Description copied from interface: Value

Gets the ImmutableValue version of this Value such that all data is duplicated across to the new ImmutableValue. Note that once created, the ImmutableValue is not going to change.

Specified by:

asImmutable in interface Value<Map<K,V>>

Returns:

A new ImmutableValue instance

copy

MapValue<K,V> copy()

Description copied from interface: Value

Makes an independent copy of this Value with the same initial data. Both this value and the new value will refer to the same object initially.

Specified by:

copy in interface Value<Map<K,V>>

Returns:

A new copy of this Value