org.spongepowered.api.data.manipulator.immutable.common

Class AbstractImmutableMappedData<K,V,I extends ImmutableMappedData<K,V,I,M>,M extends MappedData<K,V,M,I>>

java.lang.Object

org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableData<I,M>

org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableSingleData<Map<K,V>,I,M>

org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableMappedData<K,V,I,M>

All Implemented Interfaces:

DataSerializable, ImmutableMappedData<K,V,I,M>, ImmutableDataManipulator<I,M>, ValueContainer<I>

public abstract class AbstractImmutableMappedData<K,V,I extends ImmutableMappedData<K,V,I,M>,M extends MappedData<K,V,M,I>>
extends AbstractImmutableSingleData<Map<K,V>,I,M>
implements ImmutableMappedData<K,V,I,M>

Field Summary

Fields inherited from class org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableSingleData

defaultValue, usedKey, value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractImmutableMappedData(Key<MapValue<K,V>> usedKey, Map<K,V> value)
protected	AbstractImmutableMappedData(Key<MapValue<K,V>> usedKey, Map<K,V> value, Map<K,V> defaultValue)
protected	AbstractImmutableMappedData(Map<K,V> value, Key<? extends BaseValue<Map<K,V>>> usedKey) Deprecated. Use AbstractImmutableMappedData(Key, Map, Map) instead.

Method Summary

Modifier and Type	Method and Description
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.
protected ImmutableMapValue<K,V>	getValueGetter()

Methods inherited from class org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableSingleData

asMutable, equals, get, getKeys, getValue, hashCode, registerGetters, supports

Methods inherited from class org.spongepowered.api.data.manipulator.immutable.common.AbstractImmutableData

copy, fillContainer, getValue, getValues, registerFieldGetter, registerKeyValue, toContainer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.spongepowered.api.data.manipulator.immutable.ImmutableMappedData

asMap, getMapValues

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

Constructor Detail

AbstractImmutableMappedData

@Deprecated
protected AbstractImmutableMappedData(Map<K,V> value,
                                                   Key<? extends BaseValue<Map<K,V>>> usedKey)

Deprecated. Use AbstractImmutableMappedData(Key, Map, Map) instead.

AbstractImmutableMappedData

protected AbstractImmutableMappedData(Key<MapValue<K,V>> usedKey,
                                      Map<K,V> value)

AbstractImmutableMappedData

protected AbstractImmutableMappedData(Key<MapValue<K,V>> usedKey,
                                      Map<K,V> value,
                                      Map<K,V> defaultValue)

Method Detail

getValueGetter

protected final ImmutableMapValue<K,V> getValueGetter()

Specified by:

getValueGetter in class AbstractImmutableSingleData<Map<K,V>,I extends ImmutableMappedData<K,V,I,M>,M extends MappedData<K,V,M,I>>

get

public Optional<V> get(K key)

Description copied from interface: ImmutableMappedData

Gets the value for the provided key, if available.

Specified by:

get in interface ImmutableMappedData<K,V,I extends ImmutableMappedData<K,V,I,M>,M extends MappedData<K,V,M,I>>

Parameters:

key - The key

Returns:

The value, if available

See Also:

Map.get(Object)

getMapKeys

public Set<K> getMapKeys()

Description copied from interface: ImmutableMappedData

Gets a Set of keys available in this manipulator.

Specified by:

getMapKeys in interface ImmutableMappedData<K,V,I extends ImmutableMappedData<K,V,I,M>,M extends MappedData<K,V,M,I>>

Returns:

The key set

See Also:

Map.keySet()

getMapValue

public ImmutableMapValue<K,V> getMapValue()

Description copied from interface: ImmutableMappedData

Gets the ImmutableMapValue of this manipulator.

Specified by:

getMapValue in interface ImmutableMappedData<K,V,I extends ImmutableMappedData<K,V,I,M>,M extends MappedData<K,V,M,I>>

Returns:

The map value of this manipulator