org.spongepowered.api.data.manipulator

Interface DataManipulator<M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>

Type Parameters:

M - The type of DataManipulator for comparisons

All Superinterfaces:

DataSerializable, ValueContainer<M>

All Known Subinterfaces:

AbsorptionData, AccelerationData, ActiveItemData, AffectsSpawningData, AgeableData, AgentData, AggressiveData, AngerableData, AreaEffectCloudData, ArmorStandData, ArtData, AttachedData, AuthorData, AxisData, BannerData, BeaconData, BedData, BigMushroomData, BlockItemData, BodyPartRotationalData, BreakableData, BreathingData, BreedableData, BrewingStandData, BrickData, CareerData, ChargedData, CoalData, ColoredData, CommandData, ComparatorData, ConnectedDirectionData, CookedFishData, CooldownData, CriticalHitData, CustomNameVisibleData, DamageableData, DamagingData, DecayableData, DelayableData, DespawnDelayData, DirectionalData, DirtData, DisabledSlotsData, DisarmedData, DisguisedBlockData, DisplayNameData, DominantHandData, DoublePlantData, DropData, DurabilityData, DyeableData, ElytraFlyingData, EnchantmentData, EndGatewayData, ExperienceHolderData, ExpirableData, ExplosionRadiusData, ExpOrbData, ExtendedData, FallDistanceData, FallingBlockData, FilledData, FireworkEffectData, FireworkRocketData, FishData, FlammableData, FluidItemData, FluidLevelData, FluidTankData, FlyingAbilityData, FlyingData, FoodData, FurnaceData, FuseData, GameModeData, GenerationData, GlowingData, GoldenAppleData, GravityData, GriefingData, GrowthData, HealthData, HealthScalingData, HideData, HingeData, HorseData, IgniteableData, InventoryItemData, InvisibilityData, InvulnerabilityData, InWallData, JohnnyData, JoinData, KnockbackData, LayeredData, LeashData, ListData<E,M,I>, LockableData, LogAxisData, LoreData, MapItemData, MappedData<K,V,M,I>, MinecartBlockData, MobSpawnerData, MoistureData, MovementSpeedData, NoteData, OccupiedData, OcelotData, OpenData, PagedData, ParrotData, PassengerData, PersistingData, PickupDelayData, PickupRuleData, PigSaddleData, PistonData, PlaceableData, PlainPagedData, PlantData, PlayerCreatedData, PlayingData, PortionData, PotionColorData, PotionEffectData, PotionTypeData, PoweredData, PrismarineData, QuartzData, RabbitData, RailDirectionData, RedstonePoweredData, RepresentedItemData, RepresentedPlayerData, RespawnLocationData, RotationalData, SandData, SandstoneData, ScreamingData, SeamlessData, ShatteringData, ShearedData, ShrubData, SignData, SilentData, SittingData, SizeData, SkinData, SkullData, SlabData, SleepingData, SlimeData, SneakingData, SnowedData, SpawnableData, SprintData, StairShapeData, StatisticData, StoneData, StoredEnchantmentData, StructureData, StuckArrowsData, TameableData, TargetedEntityData, TargetedLocationData, TradeOfferData, TreeData, VariantData<E,T,I>, VehicleData, VelocityData, WallData, WetData, WireAttachmentData

All Known Implementing Classes:

AbstractBooleanData, AbstractBoundedComparableData, AbstractData, AbstractIntData, AbstractListData, AbstractMappedData, AbstractSingleCatalogData, AbstractSingleData, AbstractSingleEnumData

public interface DataManipulator<M extends DataManipulator<M,I>,I extends ImmutableDataManipulator<I,M>>
extends DataSerializable, ValueContainer<M>

Represents a changelist of data that can be applied to a DataHolder. With a DataManipulator, specific sets of mutable data can be represented and changed outside the live state of the DataHolder.

DataManipulators are serializable such that they can be serialized and deserialized from persistence, and applied to DataHolders, even with specialized Functions to use transform(Key, Function) such that the DataManipulator is always returned.

Method Summary

Modifier and Type	Method and Description
I	asImmutable() Gets an ImmutableDataManipulator copy of this DataManipulator such that all backed Values are copied into ImmutableValue counterparts.
M	copy() Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.
default Optional<M>	fill(DataHolder dataHolder) Attempts to read data from the given DataHolder and fills the associated data onto this DataManipulator.
Optional<M>	fill(DataHolder dataHolder, MergeFunction overlap) Attempts to read data from the given DataHolder and fills the associated data onto this DataManipulator.
Optional<M>	from(DataContainer container) Attempts to read the raw data from the provided DataContainer.
default M	set(BaseValue<?>... values) Sets the supported BaseValues onto this DataManipulator.
default M	set(BaseValue<?> value) Sets the supported BaseValue onto this DataManipulator.
default M	set(Iterable<? extends BaseValue<?>> values) Sets the supported BaseValues onto this DataManipulator.
<E> M	set(Key<? extends BaseValue<E>> key, E value) Sets the supported Key's value such that the value is set on this DataManipulator without having to directly set the Value and set(BaseValue) afterwards.
default <E> M	transform(Key<? extends BaseValue<E>> key, Function<E,E> function) Applies a transformation on the provided value if available.

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

fill

default Optional<M> fill(DataHolder dataHolder)

Attempts to read data from the given DataHolder and fills the associated data onto this DataManipulator.

Any data that overlaps existing data from the DataHolder will take priority and be overwritten from the pre-existing data from the DataHolder. It is recommended that a call from CompositeValueStore.supports(Class) is checked prior to using this method on any DataHolder.

Parameters:

dataHolder - The DataHolder to extract data

Returns:

This DataManipulator with relevant data filled from the given DataHolder, if compatible

fill

Optional<M> fill(DataHolder dataHolder,
                 MergeFunction overlap)

Attempts to read data from the given DataHolder and fills the associated data onto this DataManipulator. Any data that overlaps between this and the given DataHolder will be resolved using the given MergeFunction.

Any data that overlaps existing data from the DataHolder will take priority and be overwritten from the pre-existing data from the DataHolder. It is recommended that a call from CompositeValueStore.supports(Class) is checked prior to using this method on any DataHolder.

Parameters:

dataHolder - The DataHolder to extract data

overlap - The overlap resolver to decide which data to retain

Returns:

This DataManipulator with relevant data filled from the given DataHolder, if compatible

from

Optional<M> from(DataContainer container)

Attempts to read the raw data from the provided DataContainer. This manipulator should be "reset" to a default state and apply all data from the given DataContainer. If data is missing from the DataContainer, Optional.empty() can be returned.

Parameters:

container - The container of raw data

Returns:

This DataManipulator with relevant data filled from the given DataContainer, if compatible

set

<E> M set(Key<? extends BaseValue<E>> key,
          E value)

Sets the supported Key's value such that the value is set on this DataManipulator without having to directly set the Value and set(BaseValue) afterwards. The requirement for this to succeed is that the Key must be checked that it is supported via ValueContainer.supports(BaseValue) or ValueContainer.supports(Key) otherwise an IllegalArgumentException may be thrown. For fluency, after setting, this DataManipulator is returned.

Type Parameters:

E - The type of value

Parameters:

key - The key of the value to set

value - The actual value to set

Returns:

This manipulator, for chaining

set

default M set(BaseValue<?> value)

Sets the supported BaseValue onto this DataManipulator. The requirement for this to succeed is that the BaseValue is checked for support via ValueContainer.supports(BaseValue) or ValueContainer.supports(Key) otherwise an IllegalArgumentException may be thrown. For fluency, after setting, this DataManipulator is returned.

Parameters:

value - The actual value to set

Returns:

This manipulator, for chaining

set

default M set(BaseValue<?>... values)

Sets the supported BaseValues onto this DataManipulator. The requirement for this to succeed is that the BaseValue is checked for support via ValueContainer.supports(BaseValue) or ValueContainer.supports(Key) otherwise an IllegalArgumentException may be thrown. For fluency, after setting, this DataManipulator is returned.

Parameters:

values - The actual values to set

Returns:

This manipulator, for chaining

set

default M set(Iterable<? extends BaseValue<?>> values)

Sets the supported BaseValues onto this DataManipulator. The requirement for this to succeed is that the BaseValue is checked for support via ValueContainer.supports(BaseValue) or ValueContainer.supports(Key) otherwise an IllegalArgumentException may be thrown. For fluency, after setting, this DataManipulator is returned.

Parameters:

values - The actual values to set

Returns:

This manipulator, for chaining

transform

default <E> M transform(Key<? extends BaseValue<E>> key,
                        Function<E,E> function)

Applies a transformation on the provided value if available. This is the same as CompositeValueStore.transform(Key, Function).

Type Parameters:

E - The type of element

Parameters:

key - The key to use

function - The function to apply

Returns:

This manipulator, for chaining

copy

M copy()

Description copied from interface: ValueContainer

Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.

Specified by:

copy in interface ValueContainer<M extends DataManipulator<M,I>>

Returns:

The new copy

asImmutable

I asImmutable()

Gets an ImmutableDataManipulator copy of this DataManipulator such that all backed Values are copied into ImmutableValue counterparts. Any changes to this DataManipulator will NOT be reflected on the returned ImmutableDataManipulator and vice versa.

Returns:

This DataManipulator's data copied into a ImmutableDataManipulator