Package org.spongepowered.api.data

Interface DataHolder.Mutable

All Superinterfaces:

DataHolder, ValueContainer

All Known Subinterfaces:

AcceleratingProjectile, Aerial, Ageable, Agent, Allay, Ambient, Angerable, Animal, Aquatic, Archetype<S,E>, AreaEffectCloud, Armadillo, ArmorStand, Arrow, ArrowLike, Attackable, Axolotl, Banner, Barrel, Bat, Beacon, Bed, Bee, Beehive, Bell, BlastFurnace, Blaze, BlockDisplay, BlockEntity, BlockEntityArchetype, BlockOccupiedMinecart, Boat, Bogged, Boss, Breedable, Breeze, BreezeWindCharge, BrewingStand, Camel, Campfire, CarrierBlockEntity, CarrierMinecart<M>, Cat, CaveSpider, Chargeable, Chest, ChestBoat, ChestMinecart, Chicken, ClientPlayer, ClientWorldProperties, Cod, CommandBlock, CommandBlockMinecart, Comparator, ComplexLiving<T>, ComplexLivingPart<P>, Conduit, Cow, Crafter, Creeper, DaylightDetector, DirectionRelativeDataHolder.Mutable, Dispenser, DisplayEntity, Dolphin, Donkey, DragonFireball, Dropper, Drowned, Egg, ElderGuardian, EnchantmentTable, EndCrystal, EnderChest, EnderDragon, EnderDragonPart, Enderman, Endermite, EnderPearl, EndGateway, EndPortal, Entity, EntityArchetype, Evoker, EvokerFangs, ExperienceBottle, ExperienceOrb, Explosive, ExplosiveFireball, EyeOfEnder, FallingBlock, FireworkRocket, Fish, FishingBobber, FluidStack, Fox, Frog, Furnace, FurnaceBlockEntity, FurnaceMinecart, FusedExplosive, Ghast, Giant, GlowItemFrame, GlowSquid, Goat, Golem, Guardian, Hanging, Hoglin, Hopper, HopperMinecart, Horse, HorseLike, Hostile, Human, Humanoid, Husk, IgnitingProjectile, Illager, Illusioner, Interaction, IronGolem, Item, ItemDisplay, ItemFrame, ItemRepresentable, ItemStack, Jigsaw, Jukebox, Leashable, LeashKnot, Lectern, LightningBolt, Living, Llama, LlamaSpit, LocalPlayer, MagmaCube, MapInfo, Marker, Merchant, Minecart, MinecartLike, MobSpawner, Monster, Mooshroom, Mule, NameableBlockEntity, NameableCarrierBlockEntity, Ocelot, OminousItemSpawner, Ownable, PackHorse, Painting, Panda, Parrot, PathfinderAgent, Patroller, Phantom, Pig, Piglin, PiglinBrute, PiglinLike, Pillager, Piston, Player, PolarBear, Potion, PrimedTNT, Projectile, Pufferfish, Rabbit, Raider, RangedAgent, Ranger, Ravager, RemotePlayer, Saddleable, Salmon, SchoolingFish, SculkSensor, SerializableDataHolder.Mutable, ServerLocation, ServerPlayer, ServerWorldProperties, Sheep, Shulker, ShulkerBox, ShulkerBullet, Sign, Sign.SignText, Silverfish, Sittable, Skeleton, SkeletonHorse, SkeletonLike, Skull, Slime, SmallFireball, Smoker, Sniffer, Snowball, SnowGolem, Spawner, SpawnerMinecart, SpectralArrow, Spellcaster, Spider, Squid, Stray, Strider, StructureBlock, Tadpole, TameableAnimal, Targeting, TextDisplay, ThrowableItemProjectile, TNTMinecart, TraderLlama, TrappedChest, TrialSpawner, Trident, TropicalFish, Turtle, User, Vehicle, Vex, ViewableInventory.Custom, Villager, VillagerLike, Vindicator, WanderingTrader, Warden, WindCharge, WindChargeLike, Witch, Wither, WitherSkeleton, WitherSkull, Wolf, WorldChunk, WorldProperties, Zoglin, Zombie, ZombieHorse, ZombieVillager, ZombifiedPiglin

Enclosing interface:

DataHolder

public static interface DataHolder.Mutable
extends DataHolder

Represents a data holder that allows its data to be modified.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder

DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
default DataTransactionResult	copyFrom(ValueContainer that)	Performs an absolute copy of all Value.Mutables and ValueContainers to this DataHolder.Mutable such that any overlapping Value.Mutables are offered for replacement.
DataTransactionResult	copyFrom(ValueContainer that, MergeFunction function)	Performs an absolute copy of all Value.Mutables and ValueContainers to this DataHolder.Mutable such that any overlapping Value.Mutables are offered for replacement.
default <E> DataTransactionResult	offer(Supplier<? extends Key<? extends Value<E>>> key, E value)	Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced Values from this DataHolder.Mutable.
default <E> DataTransactionResult	offer(Supplier<? extends Key<? extends Value<E>>> key, Supplier<? extends E> value)	Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced Values from this DataHolder.Mutable.
<E> DataTransactionResult	offer(Key<? extends Value<E>> key, E value)	Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced Values from this DataHolder.Mutable.
DataTransactionResult	offer(Value<?> value)	Offers the given Value as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced Values from this DataHolder.Mutable.
default <E> DataTransactionResult	offerAll(Supplier<? extends Key<? extends CollectionValue<E,?>>> key, Collection<? extends E> elements)
default <K, V> DataTransactionResult	offerAll(Supplier<? extends Key<? extends MapValue<K,V>>> key, Map<? extends K,? extends V> map)
<E> DataTransactionResult	offerAll(Key<? extends CollectionValue<E,?>> key, Collection<? extends E> elements)
<K, V> DataTransactionResult	offerAll(Key<? extends MapValue<K,V>> key, Map<? extends K,? extends V> map)
DataTransactionResult	offerAll(CollectionValue<?,?> value)
DataTransactionResult	offerAll(MapValue<?,?> value)
default <E> DataTransactionResult	offerSingle(Supplier<? extends Key<? extends CollectionValue<E,?>>> key, E element)
default <K, V> DataTransactionResult	offerSingle(Supplier<? extends Key<? extends MapValue<K,V>>> key, K valueKey, V value)
<E> DataTransactionResult	offerSingle(Key<? extends CollectionValue<E,?>> key, E element)
<K, V> DataTransactionResult	offerSingle(Key<? extends MapValue<K,V>> key, K valueKey, V value)
default DataTransactionResult	remove(Supplier<? extends Key<?>> key)	Attempts to remove the data associated with the provided Key.
DataTransactionResult	remove(Key<?> key)	Attempts to remove the data associated with the provided Key.
default DataTransactionResult	remove(Value<?> value)	Attempts to remove the provided Value.
default <E> DataTransactionResult	removeAll(Supplier<? extends Key<? extends CollectionValue<E,?>>> key, Collection<? extends E> elements)
default <K, V> DataTransactionResult	removeAll(Supplier<? extends Key<? extends MapValue<K,V>>> key, Map<? extends K,? extends V> map)
<E> DataTransactionResult	removeAll(Key<? extends CollectionValue<E,?>> key, Collection<? extends E> elements)
<K, V> DataTransactionResult	removeAll(Key<? extends MapValue<K,V>> key, Map<? extends K,? extends V> map)
DataTransactionResult	removeAll(CollectionValue<?,?> value)
DataTransactionResult	removeAll(MapValue<?,?> value)
default <K> DataTransactionResult	removeKey(Supplier<? extends Key<? extends MapValue<K,?>>> key, K mapKey)
<K> DataTransactionResult	removeKey(Key<? extends MapValue<K,?>> key, K mapKey)
default <E> DataTransactionResult	removeSingle(Supplier<? extends Key<? extends CollectionValue<E,?>>> key, E element)
<E> DataTransactionResult	removeSingle(Key<? extends CollectionValue<E,?>> key, E element)
default <E> DataTransactionResult	transform(Supplier<? extends Key<? extends Value<E>>> key, Function<E,E> function)	Applies a transformation on the provided Value such that the return value of Function.apply(Object) will become the end resulting value set into this DataHolder.Mutable.
default <E> DataTransactionResult	transform(Key<? extends Value<E>> key, Function<E,E> function)	Applies a transformation on the provided Value such that the return value of Function.apply(Object) will become the end resulting value set into this DataHolder.Mutable.
default <E> DataTransactionResult	tryOffer(Supplier<? extends Key<? extends Value<E>>> key, E value)	Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful Values from this DataHolder.Mutable.
<E> DataTransactionResult	tryOffer(Key<? extends Value<E>> key, E value)	Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful Values from this DataHolder.Mutable.
default <E> DataTransactionResult	tryOffer(Value<E> value)	Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful Values from this DataHolder.Mutable.
DataTransactionResult	undo(DataTransactionResult result)	Attempts to "revert" a DataTransactionResult such that any of the DataTransactionResult.replacedData() are offered back, and any DataTransactionResult.successfulData() are removed if they were not the same types as any exising in the replaced values.

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

get, getDouble, getInt, getKeys, getLong, getOrElse, getOrNull, getValue, getValues, require, requireValue, supports, supports

Method Details

transform

default <E> DataTransactionResult transform(Key<? extends Value<E>> key,
 Function<E,E> function)

Applies a transformation on the provided Value such that the return value of Function.apply(Object) will become the end resulting value set into this DataHolder.Mutable. It is not necessary that the input is actually present, in which case the Keyed data is compatible, but not necessarily present. Writing a Function to properly handle the potential for a null input is required for this method to execute without exception.

Type Parameters:

E - The type of value

Parameters:

key - The key linked to

function - The function to manipulate the value

Returns:

The end resulting value

transform

default <E> DataTransactionResult transform(Supplier<? extends Key<? extends Value<E>>> key,
 Function<E,E> function)

Applies a transformation on the provided Value such that the return value of Function.apply(Object) will become the end resulting value set into this DataHolder.Mutable. It is not necessary that the input is actually present, in which case the Keyed data is compatible, but not necessarily present. Writing a Function to properly handle the potential for a null input is required for this method to execute without exception.

Type Parameters:

E - The type of value

Parameters:

key - The key linked to

function - The function to manipulate the value

Returns:

The end resulting value

offer

<E> DataTransactionResult offer(Key<? extends Value<E>> key,
 E value)

Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced Values from this DataHolder.Mutable.

Type Parameters:

E - The type of value

Parameters:

key - The key to the value to set

value - The value to set

Returns:

The transaction result

offer

default <E> DataTransactionResult offer(Supplier<? extends Key<? extends Value<E>>> key,
 E value)

Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced Values from this DataHolder.Mutable.

Type Parameters:

E - The type of value

Parameters:

key - The key to the value to set

value - The value to set

Returns:

The transaction result

offer

default <E> DataTransactionResult offer(Supplier<? extends Key<? extends Value<E>>> key,
 Supplier<? extends E> value)

Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced Values from this DataHolder.Mutable.

Type Parameters:

E - The type of value

Parameters:

key - The key to the value to set

value - The value to set

Returns:

The transaction result

offer

DataTransactionResult offer(Value<?> value)

Offers the given Value as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced Values from this DataHolder.Mutable.

Parameters:

value - The value to set

Returns:

The transaction result

offerSingle

<E> DataTransactionResult offerSingle(Key<? extends CollectionValue<E,?>> key,
 E element)

offerSingle

default <E> DataTransactionResult offerSingle(Supplier<? extends Key<? extends CollectionValue<E,?>>> key,
 E element)

offerSingle

<K,
V> DataTransactionResult offerSingle(Key<? extends MapValue<K,V>> key,
 K valueKey,
 V value)

offerSingle

default <K,
V> DataTransactionResult offerSingle(Supplier<? extends Key<? extends MapValue<K,V>>> key,
 K valueKey,
 V value)

offerAll

<K,
V> DataTransactionResult offerAll(Key<? extends MapValue<K,V>> key,
 Map<? extends K,? extends V> map)

offerAll

default <K,
V> DataTransactionResult offerAll(Supplier<? extends Key<? extends MapValue<K,V>>> key,
 Map<? extends K,? extends V> map)

offerAll

DataTransactionResult offerAll(MapValue<?,?> value)

offerAll

DataTransactionResult offerAll(CollectionValue<?,?> value)

offerAll

<E> DataTransactionResult offerAll(Key<? extends CollectionValue<E,?>> key,
 Collection<? extends E> elements)

offerAll

default <E> DataTransactionResult offerAll(Supplier<? extends Key<? extends CollectionValue<E,?>>> key,
 Collection<? extends E> elements)

removeSingle

<E> DataTransactionResult removeSingle(Key<? extends CollectionValue<E,?>> key,
 E element)

removeSingle

default <E> DataTransactionResult removeSingle(Supplier<? extends Key<? extends CollectionValue<E,?>>> key,
 E element)

removeKey

<K> DataTransactionResult removeKey(Key<? extends MapValue<K,?>> key,
 K mapKey)

removeKey

default <K> DataTransactionResult removeKey(Supplier<? extends Key<? extends MapValue<K,?>>> key,
 K mapKey)

removeAll

DataTransactionResult removeAll(CollectionValue<?,?> value)

removeAll

<E> DataTransactionResult removeAll(Key<? extends CollectionValue<E,?>> key,
 Collection<? extends E> elements)

removeAll

default <E> DataTransactionResult removeAll(Supplier<? extends Key<? extends CollectionValue<E,?>>> key,
 Collection<? extends E> elements)

removeAll

DataTransactionResult removeAll(MapValue<?,?> value)

removeAll

<K,
V> DataTransactionResult removeAll(Key<? extends MapValue<K,V>> key,
 Map<? extends K,? extends V> map)

removeAll

default <K,
V> DataTransactionResult removeAll(Supplier<? extends Key<? extends MapValue<K,V>>> key,
 Map<? extends K,? extends V> map)

tryOffer

<E> DataTransactionResult tryOffer(Key<? extends Value<E>> key,
 E value)

Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful Values from this DataHolder.Mutable. Intentionally, however, this differs from offer(Key, Object) as it will intentionally throw an exception if the result was a failure.

Type Parameters:

E - The type of value

Parameters:

key - The key to the value to set

value - The value to set

Returns:

The transaction result

Throws:

IllegalArgumentException - If the result is a failure likely due to incompatibility

tryOffer

default <E> DataTransactionResult tryOffer(Supplier<? extends Key<? extends Value<E>>> key,
 E value)

Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful Values from this DataHolder.Mutable. Intentionally, however, this differs from offer(Key, Object) as it will intentionally throw an exception if the result was a failure.

Type Parameters:

E - The type of value

Parameters:

key - The key to the value to set

value - The value to set

Returns:

The transaction result

Throws:

IllegalArgumentException - If the result is a failure likely due to incompatibility

tryOffer

default <E> DataTransactionResult tryOffer(Value<E> value)
                                    throws IllegalArgumentException

Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful Values from this DataHolder.Mutable. Intentionally, however, this differs from offer(Key, Object) as it will intentionally throw an exception if the result was a failure.

Type Parameters:

E - The type of value

Parameters:

value - The value to set

Returns:

The transaction result

Throws:

IllegalArgumentException - If the result is a failure likely due to incompatibility

remove

default DataTransactionResult remove(Value<?> value)

Attempts to remove the provided Value. All values that were successfully removed will be provided in DataTransactionResult.replacedData(). If the data can not be removed, the result will be an expected DataTransactionResult.Type.FAILURE.

Parameters:

value - The value to remove

Returns:

The transaction result

remove

DataTransactionResult remove(Key<?> key)

Attempts to remove the data associated with the provided Key. All values that were successfully removed will be provided in DataTransactionResult.replacedData(). If the data can not be removed, the result will be an expected DataTransactionResult.Type.FAILURE.

Parameters:

key - The key of the data

Returns:

The transaction result

remove

default DataTransactionResult remove(Supplier<? extends Key<?>> key)

Attempts to remove the data associated with the provided Key. All values that were successfully removed will be provided in DataTransactionResult.replacedData(). If the data can not be removed, the result will be an expected DataTransactionResult.Type.FAILURE.

Parameters:

key - The key of the data

Returns:

The transaction result

undo

DataTransactionResult undo(DataTransactionResult result)

Attempts to "revert" a DataTransactionResult such that any of the DataTransactionResult.replacedData() are offered back, and any DataTransactionResult.successfulData() are removed if they were not the same types as any exising in the replaced values.

Parameters:

result - The result to undo

Returns:

The result of the undo

copyFrom

default DataTransactionResult copyFrom(ValueContainer that)

Performs an absolute copy of all Value.Mutables and ValueContainers to this DataHolder.Mutable such that any overlapping Value.Mutables are offered for replacement. The result is provided as a DataTransactionResult.

Parameters:

that - The other DataHolder.Mutable to copy values from

Returns:

The transaction result

copyFrom

DataTransactionResult copyFrom(ValueContainer that,
 MergeFunction function)

Performs an absolute copy of all Value.Mutables and ValueContainers to this DataHolder.Mutable such that any overlapping Value.Mutables are offered for replacement. The result is provided as a DataTransactionResult.

Parameters:

that - The other DataHolder.Mutable to copy values from

function - The function to resolve merge conflicts

Returns:

The transaction result