org.spongepowered.api.data.value.mutable

Interface CompositeValueStore<S extends CompositeValueStore<S,H>,H extends ValueContainer<?>>

Type Parameters:

S - The type of composite store, for self referencing

H - The type of ValueContainer to restrict accessing of values to

All Superinterfaces:

ValueContainer<S>

All Known Subinterfaces:

Aerial, Ageable, Agent, Ambient, Animal, Aquatic, Archetype<S,E>, AreaEffectCloud, ArmorStand, Arrow, Banner, Bat, Beacon, Bed, Blaze, Boat, Boss, BrewingStand, CaveSpider, Chest, ChestMinecart, Chicken, CommandBlock, CommandBlockMinecart, CommandBlockSource, Comparator, ComplexLiving, ComplexLivingPart, ContainerMinecart<M>, Cow, Creature, Creeper, DamagingProjectile, DataHolder, DaylightDetector, Dispenser, Donkey, DragonFireball, Dropper, Egg, EnchantmentTable, EnderChest, EnderCrystal, EnderDragon, EnderDragonPart, Enderman, Endermite, EnderPearl, EndGateway, EndPortal, Entity, EntityArchetype, EntityTargetingProjectile, Evoker, ExperienceOrb, Explosive, EyeOfEnder, FallingBlock, Fireball, Firework, FishHook, FlowerPot, FluidStack, Furnace, FurnaceMinecart, FusedExplosive, Ghast, Giant, Golem, Guardian, Hanging, Hopper, HopperMinecart, Horse, Hostile, Human, Humanoid, Husk, Illusioner, IronGolem, Item, ItemFrame, ItemStack, Jukebox, LargeFireball, LeashHitch, Lightning, Living, Llama, LlamaSpit, MagmaCube, Merchant, Minecart, MobSpawner, MobSpawnerMinecart, Monster, Mooshroom, Mule, Note, Ocelot, Painting, Parrot, Pig, Piston, Player, PolarBear, PrimedTNT, Projectile, Rabbit, Ranger, RideableHorse, RideableMinecart, Sheep, Shulker, ShulkerBox, ShulkerBullet, Sign, Silverfish, Skeleton, SkeletonHorse, Skull, Slime, SmallFireball, Snowball, SnowGolem, SpectralArrow, Spider, Squid, Stray, Structure, ThrownExpBottle, ThrownPotion, TileEntity, TileEntityArchetype, TileEntityCarrier, TippedArrow, TNTMinecart, User, Vex, Villager, Vindicator, WeatherEffect, WhiteSkeleton, Witch, Wither, WitherSkeleton, WitherSkull, Wolf, Zombie, ZombieHorse, ZombiePigman, ZombieVillager

All Known Implementing Classes:

Location

public interface CompositeValueStore<S extends CompositeValueStore<S,H>,H extends ValueContainer<?>>
extends ValueContainer<S>

Represents a ValueContainer that contains a various bundle of ValueContainers of type declared by the extension that can be manipulated separately from this CompositeValueStore.

Method Summary

Modifier and Type	Method and Description
default DataTransactionResult	copyFrom(S that) Performs an absolute copy of all Values and ValueContainers to this CompositeValueStore such that any overlapping Values are offered for replacement.
DataTransactionResult	copyFrom(S that, MergeFunction function) Performs an absolute copy of all Values and ValueContainers to this CompositeValueStore such that any overlapping Values are offered for replacement.
<T extends H> Optional<T>	get(Class<T> containerClass) Gets the desired ValueContainer of type H if the ValueContainer is compatible.
Collection<H>	getContainers() Gets an copied collection of all known ValueContainers belonging to this CompositeValueStore.
<T extends H> Optional<T>	getOrCreate(Class<T> containerClass) Gets the desired ValueContainer of type H if the ValueContainer is compatible.
default <E> DataTransactionResult	offer(BaseValue<E> value) Offers the given BaseValue as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced BaseValues from this CompositeValueStore.
default DataTransactionResult	offer(H valueContainer) Offers the given ValueContainer such that all of the available BaseValues from the given ValueContainer are offered to this CompositeValueStore.
DataTransactionResult	offer(H valueContainer, MergeFunction function) Offers the given ValueContainer such that all of the available BaseValues from the given ValueContainer are offered to this CompositeValueStore.
default DataTransactionResult	offer(Iterable<H> valueContainers) Offers all provided ValueContainers to this CompositeValueStore much like offer(ValueContainer) except all in a single batch.
default DataTransactionResult	offer(Iterable<H> valueContainers, MergeFunction function) Offers all provided ValueContainers to this CompositeValueStore much like offer(ValueContainer) except all in a single batch.
<E> DataTransactionResult	offer(Key<? extends BaseValue<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 BaseValues from this CompositeValueStore.
default DataTransactionResult	remove(BaseValue<?> value) Attempts to remove the provided BaseValue.
DataTransactionResult	remove(Class<? extends H> containerClass) Attempts to remove all Values associated with the class of the provided ValueContainer class.
DataTransactionResult	remove(Key<?> key) Attempts to remove the data associated with the provided Key.
default <T extends H> T	require(Class<T> containerClass) Gets the desired ValueContainer of type H if the ValueContainer is compatible.
boolean	supports(Class<? extends H> holderClass) Checks if the given Class of type ValueContainer is supported by this CompositeValueStore.
default <E> DataTransactionResult	transform(Key<? extends BaseValue<E>> key, Function<E,E> function) Applies a transformation on the provided BaseValue such that the return value of Function.apply(Object) will become the end resulting value set into this CompositeValueStore.
default <E> DataTransactionResult	tryOffer(BaseValue<E> value) Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful BaseValues from this CompositeValueStore.
default DataTransactionResult	tryOffer(H valueContainer) Offers the given ValueContainer such that all of the available BaseValues from the given ValueContainer are offered to this CompositeValueStore.
default DataTransactionResult	tryOffer(H valueContainer, MergeFunction function) Offers the given ValueContainer such that all of the available BaseValues from the given ValueContainer are offered to this CompositeValueStore.
default <E> DataTransactionResult	tryOffer(Key<? extends BaseValue<E>> key, E value) Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful BaseValues from this CompositeValueStore.
DataTransactionResult	undo(DataTransactionResult result) Attempts to "revert" a DataTransactionResult such that any of the DataTransactionResult.getReplacedData() are offered back, and any DataTransactionResult.getSuccessfulData() 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

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

get

<T extends H> Optional<T> get(Class<T> containerClass)

Gets the desired ValueContainer of type H if the ValueContainer is compatible. Since the return type is an Optional, a short way of checking compatibility and presence of the requested data is to mimic the following:

// MyCompositeValueStore extends CompositeValueStore<MyCompositeValueStore, DataManipulator<?>>
MyCompositeValueStore valueStore;
final Optional<DisplayNameData> displayOptional = valueStore.get(DisplayNameData.class);
if (displayOptional.isPresent()) {
// We know that we have a present DataManipulator and it's supported
System.out.println(displayOptional.get().displayName().get().toString());
}

This is the equivalent to performing the following:

MyCompositeValueStore valueStore;
if (valueStore.supports(DisplayNameData.class)) {
System.out.println(valueStore.getOrNull(DisplayNameData.class ).displayName().get().toString());
}

The advantage of this returning an Optional is that the ValueContainer may be unsupported, the required data missing and ignoring the possibility of nulls, it is a guarantee that if the Optional.isPresent() is true, the ValueContainer not only is supported, but there is already pre- existing data for the ValueContainer.

If it is necessary to ignore the Optional, Optional.orElse(Object) can be used to return a potentially null ValueContainer.

Type Parameters:

T - The type of ValueContainer

Parameters:

containerClass - The container class

Returns:

The value container, if available

require

default <T extends H> T require(Class<T> containerClass)

Gets the desired ValueContainer of type H if the ValueContainer is compatible.

If the container class is not supported or available, NoSuchElementException will be thrown.

Type Parameters:

T - The type of ValueContainer

Parameters:

containerClass - The container class

Returns:

The value

Throws:

NoSuchElementException - If the value is not supported or present

getOrCreate

<T extends H> Optional<T> getOrCreate(Class<T> containerClass)

Gets the desired ValueContainer of type H if the ValueContainer is compatible. If insufficient data is available to provide a ValueContainer with all Values preset, a new instance of the ValueContainer is returned with "default" values. Since the return type is an Optional, a short way of checking compatibility and presence of the requested data is to mimic the following:

// MyCompositeValueStore extends CompositeValueStore<MyCompositeValueStore, DataManipulator<?>>
MyCompositeValueStore valueStore;
final Optional<DisplayNameData> displayOptional = valueStore.getOrCreate(DisplayNameData.class);
if (displayOptional.isPresent()) {
// We know that we have a present DataManipulator and it's supported
System.out.println(displayOptional.get().displayName().get().toString() );
}

This is the equivalent to performing the following:

MyCompositeValueStore valueStore;
if (valueStore.supports(DisplayNameData.class)) {
System.out.println(valueStore.get(DisplayNameData.class ).get().displayName().get().toString());
}

The advantage of this returning an Optional is that the ValueContainer may be unsupported, the required data missing and ignoring the possibility of nulls, it is a guarantee that if the Optional.isPresent() is true, the ValueContainer not only is supported, but some default values can be generated to create the desired ValueContainer.

If it is necessary to ignore the Optional, Optional.orElse(Object) can be used to return a potentially null ValueContainer.

Type Parameters:

T - The type of ValueContainer

Parameters:

containerClass - The container class

Returns:

The value container, if compatible

supports

boolean supports(Class<? extends H> holderClass)

Checks if the given Class of type ValueContainer is supported by this CompositeValueStore.

Parameters:

holderClass - The container class

Returns:

True if the class is supported

transform

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

Applies a transformation on the provided BaseValue such that the return value of Function.apply(Object) will become the end resulting value set into this CompositeValueStore. 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 BaseValue<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 BaseValues from this CompositeValueStore.

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(BaseValue<E> value)

Offers the given BaseValue as defined by the provided Key such that a DataTransactionResult is returned for any successful, rejected, and replaced BaseValues from this CompositeValueStore.

Type Parameters:

E - The type of the element wrapped by the value

Parameters:

value - The value to set

Returns:

The transaction result

offer

default DataTransactionResult offer(H valueContainer)

Offers the given ValueContainer such that all of the available BaseValues from the given ValueContainer are offered to this CompositeValueStore. The end result of the values successfully offered, rejected, and replaced are stored in the returned DataTransactionResult.

Parameters:

valueContainer - The value to set

Returns:

The transaction result

offer

DataTransactionResult offer(H valueContainer,
                            MergeFunction function)

Offers the given ValueContainer such that all of the available BaseValues from the given ValueContainer are offered to this CompositeValueStore. The end result of the values successfully offered, rejected, and replaced are stored in the returned DataTransactionResult. Any overlaps of data are merged via the MergeFunction.

Parameters:

valueContainer - The value to set

function - The merge function

Returns:

The transaction result

offer

default DataTransactionResult offer(Iterable<H> valueContainers)

Offers all provided ValueContainers to this CompositeValueStore much like offer(ValueContainer) except all in a single batch. The end result of the values successfully offered, rejected, and replaced are stored in the returned DataTransactionResult.

Parameters:

valueContainers - The values to set

Returns:

The transaction result

offer

default DataTransactionResult offer(Iterable<H> valueContainers,
                                    MergeFunction function)

Offers all provided ValueContainers to this CompositeValueStore much like offer(ValueContainer) except all in a single batch. The end result of the values successfully offered, rejected, and replaced are stored in the returned DataTransactionResult. Any merge conflicts are resolved through the MergeFunction.

Parameters:

valueContainers - The values to set

function - The function to resolve the values

Returns:

The transaction result

tryOffer

default <E> DataTransactionResult tryOffer(Key<? extends BaseValue<E>> key,
                                           E value)
                                    throws IllegalArgumentException

Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful BaseValues from this CompositeValueStore. 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(BaseValue<E> value)
                                    throws IllegalArgumentException

Offers the given value as defined by the provided Key such that a DataTransactionResult is returned for any successful BaseValues from this CompositeValueStore. 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

tryOffer

default DataTransactionResult tryOffer(H valueContainer)

Offers the given ValueContainer such that all of the available BaseValues from the given ValueContainer are offered to this CompositeValueStore. Intentionally, however, this differs from offer(ValueContainer) as it will intentionally throw an exception if the result was a failure.

Parameters:

valueContainer - The value to set

Returns:

The transaction result

Throws:

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

tryOffer

default DataTransactionResult tryOffer(H valueContainer,
                                       MergeFunction function)
                                throws IllegalArgumentException

Offers the given ValueContainer such that all of the available BaseValues from the given ValueContainer are offered to this CompositeValueStore. Any overlaps of data are merged via the MergeFunction. Intentionally, however, this differs from offer(ValueContainer) as it will intentionally throw an exception if the result was a failure.

Parameters:

valueContainer - The value to set

function - The merge function

Returns:

The transaction result

Throws:

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

remove

DataTransactionResult remove(Class<? extends H> containerClass)

Attempts to remove all Values associated with the class of the provided ValueContainer class. All values that were successfully removed will be provided in DataTransactionResult.getReplacedData(). If the data can not be removed, the result will be an expected DataTransactionResult.Type.FAILURE.

Parameters:

containerClass - The container class

Returns:

The transaction result

remove

default DataTransactionResult remove(BaseValue<?> value)

Attempts to remove the provided BaseValue. All values that were successfully removed will be provided in DataTransactionResult.getReplacedData(). 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.getReplacedData(). 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.getReplacedData() are offered back, and any DataTransactionResult.getSuccessfulData() 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(S that)

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

Parameters:

that - The other CompositeValueStore to copy values from

Returns:

The transaction result

copyFrom

DataTransactionResult copyFrom(S that,
                               MergeFunction function)

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

Parameters:

that - The other CompositeValueStore to copy values from

function - The function to resolve merge conflicts

Returns:

The transaction result

getContainers

Collection<H> getContainers()

Gets an copied collection of all known ValueContainers belonging to this CompositeValueStore. An individual ValueContainer can be used for data processing for various purposes.

Returns:

A collection of copied ValueContainers originating from this value store