org.spongepowered.api.data.manipulator.immutable

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

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<I,M>, ValueContainer<I>

All Known Subinterfaces:

ImmutableFluidTankData, ImmutableRespawnLocation, ImmutableStatisticData

All Known Implementing Classes:

AbstractImmutableMappedData

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

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.
ImmutableMapValue<K,V>	getMapValue() Gets the ImmutableMapValue of this manipulator.
default Set<Map.Entry<K,V>>	getMapValues() Gets the Map.Entry Set of values.

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

asMutable, copy, with, with

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

ImmutableMapValue<K,V> getMapValue()

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