org.spongepowered.api.data.manipulator.mutable.common

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

java.lang.Object

org.spongepowered.api.data.manipulator.mutable.common.AbstractData<M,I>

org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleData<Map<K,V>,M,I>

org.spongepowered.api.data.manipulator.mutable.common.AbstractMappedData<K,V,M,I>

Type Parameters:

K - The type of key in the map

V - The type of value in the map

M - The type of DataManipulator

I - The type of ImmutableDataManipulator

All Implemented Interfaces:

DataSerializable, DataManipulator<M,I>, MappedData<K,V,M,I>, ValueContainer<M>

public abstract class AbstractMappedData<K,V,M extends MappedData<K,V,M,I>,I extends ImmutableMappedData<K,V,I,M>>
extends AbstractSingleData<Map<K,V>,M,I>
implements MappedData<K,V,M,I>

A common implementation for ListDatas provided by the API.

Field Summary

Fields inherited from class org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleData

defaultValue, usedKey, value

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Map<K,V>	asMap() Gets this manipulator as a Map.
boolean	equals(Object obj)
MapValue<K,V>	getMapValue() Gets the MapValue of this manipulator.
protected Map<K,V>	getValue() A simple getter for usage with a Supplier for the AbstractData.registerFieldGetter(Key, Supplier) method.
protected MapValue<K,V>	getValueGetter() Gets the Value as a method since this manipulator only focuses on a single value.
int	hashCode()
protected M	setValue(Map<K,V> value) A simple setter for usage with a Consumer for the AbstractData.registerFieldSetter(Key, Consumer) method.

Methods inherited from class org.spongepowered.api.data.manipulator.mutable.common.AbstractSingleData

asImmutable, fillContainer, get, registerGettersAndSetters, supports

Methods inherited from class org.spongepowered.api.data.manipulator.mutable.common.AbstractData

getKeys, getValue, getValues, registerFieldGetter, registerFieldSetter, registerKeyValue, set, toContainer, transform

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.mutable.MappedData

get, getMapKeys, getMapValues, put, putAll, remove

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

Constructor Detail

AbstractMappedData

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

Deprecated. Use AbstractMappedData(Key, Map) instead.

AbstractMappedData

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

AbstractMappedData

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

Method Detail

getValueGetter

protected MapValue<K,V> getValueGetter()

Description copied from class: AbstractSingleData

Gets the Value as a method since this manipulator only focuses on a single value.

Specified by:

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

Returns:

The constructed value

getValue

protected Map<K,V> getValue()

Description copied from class: AbstractSingleData

A simple getter for usage with a Supplier for the AbstractData.registerFieldGetter(Key, Supplier) method.

Overrides:

getValue in class AbstractSingleData<Map<K,V>,M extends MappedData<K,V,M,I>,I extends ImmutableMappedData<K,V,I,M>>

Returns:

The value

setValue

protected M setValue(Map<K,V> value)

Description copied from class: AbstractSingleData

A simple setter for usage with a Consumer for the AbstractData.registerFieldSetter(Key, Consumer) method.

Overrides:

setValue in class AbstractSingleData<Map<K,V>,M extends MappedData<K,V,M,I>,I extends ImmutableMappedData<K,V,I,M>>

Parameters:

value - The value

Returns:

This manipulator

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSingleData<Map<K,V>,M extends MappedData<K,V,M,I>,I extends ImmutableMappedData<K,V,I,M>>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSingleData<Map<K,V>,M extends MappedData<K,V,M,I>,I extends ImmutableMappedData<K,V,I,M>>

getMapValue

public MapValue<K,V> getMapValue()

Description copied from interface: MappedData

Gets the MapValue of this manipulator.

Specified by:

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

Returns:

The map value of this manipulator

asMap

public Map<K,V> asMap()

Description copied from interface: MappedData

Gets this manipulator as a Map.

Specified by:

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

Returns:

The map