org.spongepowered.api.data.manipulator.mutable

Interface MappedData<K,V,M extends MappedData<K,V,M,I>,I extends ImmutableMappedData<K,V,I,M>>

Type Parameters:

K - The type of key

V - The type of value

M - The mutable variant of this manipulator

I - The immutable variant of this manipulator

All Superinterfaces:

DataManipulator<M,I>, DataSerializable, ValueContainer<M>

All Known Subinterfaces:

FluidTankData, RespawnLocationData, StatisticData

All Known Implementing Classes:

AbstractMappedData

public interface MappedData<K,V,M extends MappedData<K,V,M,I>,I extends ImmutableMappedData<K,V,I,M>>
extends DataManipulator<M,I>

A variant type of DataManipulator that uses a Map.

Method Summary

Modifier and Type	Method and Description
default Map<K,V>	asMap() Gets this manipulator as a Map.
Optional<V>	get(K key) Gets the value for the provided key, if available.
Set<K>	getMapKeys() Gets a Set of keys available in this manipulator.
MapValue<K,V>	getMapValue() Gets the MapValue of this manipulator.
default Set<Map.Entry<K,V>>	getMapValues() Gets the Map.Entry Set of values.
M	put(K key, V value) Sets the value with the provided key.
M	putAll(Map<? extends K,? extends V> map) Sets all available Map.entrySet() values into this MappedData manipulator.
M	remove(K key) Removes any values keyed to the provided key.

Methods inherited from interface org.spongepowered.api.data.manipulator.DataManipulator

asImmutable, copy, fill, fill, from, set, set, set, set, transform

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

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

get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

get

Optional<V> get(K key)

Gets the value for the provided key, if available.

Parameters:

key - The key

Returns:

The value, if available

See Also:

Map.get(Object)

getMapKeys

Set<K> getMapKeys()

Gets a Set of keys available in this manipulator.

Returns:

The key set

See Also:

Map.keySet()

getMapValues

default Set<Map.Entry<K,V>> getMapValues()

Gets the Map.Entry Set of values.

Returns:

The entry set

See Also:

Map.entrySet()

getMapValue

MapValue<K,V> getMapValue()

Gets the MapValue of this manipulator.

Returns:

The map value of this manipulator

asMap

default Map<K,V> asMap()

Gets this manipulator as a Map.

Returns:

The map

put

M put(K key,
      V value)

Sets the value with the provided key.

Parameters:

key - The key

value - The value

Returns:

This manipulator, for chaining

See Also:

Map.put(Object, Object)

putAll

M putAll(Map<? extends K,? extends V> map)

Sets all available Map.entrySet() values into this MappedData manipulator.

Parameters:

map - The map containing keys and values

Returns:

This manipulator, for chaining

See Also:

Map.putAll(Map)

remove

M remove(K key)

Removes any values keyed to the provided key.

Parameters:

key - The key to remove the value of

Returns:

This manipulator, for chaining

See Also:

Map.remove(Object)