org.spongepowered.api.data.value

Interface ValueContainer<C extends ValueContainer<C>>

Type Parameters:

C - The type of container for fluency

All Known Subinterfaces:

AbsorptionData, AccelerationData, ActiveItemData, Aerial, AffectsSpawningData, Ageable, AgeableData, Agent, AgentData, AggressiveData, Ambient, AngerableData, Animal, Aquatic, Archetype<S,E>, AreaEffectCloud, AreaEffectCloudData, ArmorStand, ArmorStandData, Arrow, ArtData, AttachedData, AuthorData, AxisData, Banner, BannerData, Bat, Beacon, BeaconData, Bed, BedData, BigMushroomData, Blaze, BlockItemData, BlockSnapshot, BlockState, Boat, BodyPartRotationalData, Boss, BreakableData, BreathingData, BreedableData, BrewingStand, BrewingStandData, BrickData, CareerData, CaveSpider, ChargedData, Chest, ChestMinecart, Chicken, CoalData, ColoredData, CommandBlock, CommandBlockMinecart, CommandBlockSource, CommandData, Comparator, ComparatorData, ComplexLiving, ComplexLivingPart, CompositeValueStore<S,H>, ConnectedDirectionData, ContainerMinecart<M>, CookedFishData, CooldownData, Cow, Creature, Creeper, CriticalHitData, CustomNameVisibleData, DamageableData, DamagingData, DamagingProjectile, DataHolder, DataManipulator<M,I>, DaylightDetector, DecayableData, DelayableData, DespawnDelayData, DirectionalData, DirtData, DisabledSlotsData, DisarmedData, DisguisedBlockData, Dispenser, DisplayNameData, DominantHandData, Donkey, DoublePlantData, DragonFireball, DropData, Dropper, DurabilityData, DyeableData, Egg, ElytraFlyingData, EnchantmentData, EnchantmentTable, EnderChest, EnderCrystal, EnderDragon, EnderDragonPart, Enderman, Endermite, EnderPearl, EndGateway, EndGatewayData, EndPortal, Entity, EntityArchetype, EntitySnapshot, EntityTargetingProjectile, Evoker, ExperienceHolderData, ExperienceOrb, ExpirableData, ExplosionRadiusData, Explosive, ExpOrbData, ExtendedData, EyeOfEnder, FallDistanceData, FallingBlock, FallingBlockData, FilledData, Fireball, Firework, FireworkEffectData, FireworkRocketData, FishData, FishHook, FlammableData, FlowerPot, FluidItemData, FluidLevelData, FluidStack, FluidStackSnapshot, FluidTankData, FlyingAbilityData, FlyingData, FoodData, Furnace, FurnaceData, FurnaceMinecart, FuseData, FusedExplosive, GameModeData, GenerationData, Ghast, Giant, GlowingData, GoldenAppleData, Golem, GravityData, GriefingData, GrowthData, Guardian, Hanging, HealthData, HealthScalingData, HideData, HingeData, Hopper, HopperMinecart, Horse, HorseData, Hostile, Human, Humanoid, Husk, IgniteableData, Illusioner, ImmutableAbsorptionData, ImmutableAccelerationData, ImmutableActiveItemData, ImmutableAffectsSpawningData, ImmutableAgeableData, ImmutableAgentData, ImmutableAggressiveData, ImmutableAngerableData, ImmutableAreaEffectCloudData, ImmutableArmorStandData, ImmutableArtData, ImmutableAttachedData, ImmutableAuthorData, ImmutableAxisData, ImmutableBannerData, ImmutableBeaconData, ImmutableBedData, ImmutableBigMushroomData, ImmutableBlockItemData, ImmutableBodyPartRotationalData, ImmutableBreakableData, ImmutableBreathingData, ImmutableBreedableData, ImmutableBrewingStandData, ImmutableBrickData, ImmutableCareerData, ImmutableChargedData, ImmutableCoalData, ImmutableColoredData, ImmutableCommandData, ImmutableComparatorData, ImmutableConnectedDirectionData, ImmutableCookedFishData, ImmutableCooldownData, ImmutableCriticalHitData, ImmutableCustomNameVisibleData, ImmutableDamageableData, ImmutableDamagingData, ImmutableDataHolder<T>, ImmutableDataManipulator<I,M>, ImmutableDecayableData, ImmutableDelayableData, ImmutableDespawnDelayData, ImmutableDirectionalData, ImmutableDirtData, ImmutableDisabledSlotsData, ImmutableDisarmedData, ImmutableDisguisedBlockData, ImmutableDisplayNameData, ImmutableDominantHandData, ImmutableDoublePlantData, ImmutableDropData, ImmutableDurabilityData, ImmutableDyeableData, ImmutableElytraFlyingData, ImmutableEnchantmentData, ImmutableEndGatewayData, ImmutableExperienceHolderData, ImmutableExpirableData, ImmutableExplosionRadiusData, ImmutableExpOrbData, ImmutableExtendedData, ImmutableFallDistanceData, ImmutableFallingBlockData, ImmutableFilledData, ImmutableFireworkEffectData, ImmutableFireworkRocketData, ImmutableFishData, ImmutableFlammableData, ImmutableFluidItemData, ImmutableFluidLevelData, ImmutableFluidTankData, ImmutableFlyingAbilityData, ImmutableFlyingData, ImmutableFoodData, ImmutableFurnaceData, ImmutableFuseData, ImmutableGameModeData, ImmutableGenerationData, ImmutableGlowingData, ImmutableGoldenAppleData, ImmutableGravityData, ImmutableGriefingData, ImmutableGrowthData, ImmutableHealthData, ImmutableHealthScalingData, ImmutableHideData, ImmutableHingeData, ImmutableHorseData, ImmutableIgniteableData, ImmutableInventoryItemData, ImmutableInvisibilityData, ImmutableInvulnerabilityData, ImmutableInWallData, ImmutableJohnnyData, ImmutableJoinData, ImmutableKnockbackData, ImmutableLayeredData, ImmutableLeashData, ImmutableListData<E,I,M>, ImmutableLockableData, ImmutableLogAxisData, ImmutableLoreData, ImmutableMapItemData, ImmutableMappedData<K,V,I,M>, ImmutableMinecartBlockData, ImmutableMobSpawnerData, ImmutableMoistureData, ImmutableMovementSpeedData, ImmutableNoteData, ImmutableOccupiedData, ImmutableOcelotData, ImmutableOpenData, ImmutablePagedData, ImmutableParrotData, ImmutablePassengerData, ImmutablePersistingData, ImmutablePickupDelayData, ImmutablePickupRuleData, ImmutablePigSaddleData, ImmutablePistonData, ImmutablePlaceableData, ImmutablePlainPagedData, ImmutablePlantData, ImmutablePlayerCreatedData, ImmutablePlayingData, ImmutablePortionData, ImmutablePotionColorData, ImmutablePotionEffectData, ImmutablePotionTypeData, ImmutablePoweredData, ImmutablePrismarineData, ImmutableQuartzData, ImmutableRabbitData, ImmutableRailDirectionData, ImmutableRedstonePoweredData, ImmutableRepresentedItemData, ImmutableRepresentedPlayerData, ImmutableRespawnLocation, ImmutableRotationalData, ImmutableSandData, ImmutableSandstoneData, ImmutableScreamingData, ImmutableSeamlessData, ImmutableShatteringData, ImmutableShearedData, ImmutableShrubData, ImmutableSignData, ImmutableSilentData, ImmutableSittingData, ImmutableSizeData, ImmutableSkinData, ImmutableSkullData, ImmutableSlabData, ImmutableSleepingData, ImmutableSlimeData, ImmutableSneakingData, ImmutableSnowedData, ImmutableSpawnableData, ImmutableSprintData, ImmutableStairShapeData, ImmutableStatisticData, ImmutableStoneData, ImmutableStoredEnchantmentData, ImmutableStructureData, ImmutableStuckArrowsData, ImmutableTameableData, ImmutableTargetedEntityData, ImmutableTargetedLocationData, ImmutableTradeOfferData, ImmutableTreeData, ImmutableValueStore<I,H>, ImmutableVariantData<E,I,M>, ImmutableVehicleData, ImmutableVelocityData, ImmutableWallData, ImmutableWetData, ImmutableWireAttachmentData, InventoryItemData, InvisibilityData, InvulnerabilityData, InWallData, IronGolem, Item, ItemFrame, ItemStack, ItemStackSnapshot, JohnnyData, JoinData, Jukebox, KnockbackData, LargeFireball, LayeredData, LeashData, LeashHitch, Lightning, ListData<E,M,I>, Living, Llama, LlamaSpit, LocatableBlock, LocatableSnapshot<T>, LockableData, LogAxisData, LoreData, MagmaCube, MapItemData, MappedData<K,V,M,I>, Merchant, Minecart, MinecartBlockData, MobSpawner, MobSpawnerData, MobSpawnerMinecart, MoistureData, Monster, Mooshroom, MovementSpeedData, Mule, Note, NoteData, OccupiedData, Ocelot, OcelotData, OpenData, PagedData, Painting, Parrot, ParrotData, PassengerData, PersistingData, PickupDelayData, PickupRuleData, Pig, PigSaddleData, Piston, PistonData, PlaceableData, PlainPagedData, PlantData, Player, PlayerCreatedData, PlayingData, PolarBear, PortionData, PotionColorData, PotionEffectData, PotionTypeData, PoweredData, PrimedTNT, PrismarineData, Projectile, QuartzData, Rabbit, RabbitData, RailDirectionData, Ranger, RedstonePoweredData, RepresentedItemData, RepresentedPlayerData, RespawnLocationData, RideableHorse, RideableMinecart, RotationalData, SandData, SandstoneData, ScreamingData, SeamlessData, ShatteringData, ShearedData, Sheep, ShrubData, Shulker, ShulkerBox, ShulkerBullet, Sign, SignData, SilentData, Silverfish, SittingData, SizeData, Skeleton, SkeletonHorse, SkinData, Skull, SkullData, SlabData, SleepingData, Slime, SlimeData, SmallFireball, SneakingData, Snowball, SnowedData, SnowGolem, SpawnableData, SpectralArrow, Spider, SprintData, Squid, StairShapeData, StatisticData, StoneData, StoredEnchantmentData, Stray, Structure, StructureData, StuckArrowsData, TameableData, TargetedEntityData, TargetedLocationData, ThrownExpBottle, ThrownPotion, TileEntity, TileEntityArchetype, TileEntityCarrier, TippedArrow, TNTMinecart, TradeOfferData, TreeData, User, VariantData<E,T,I>, VehicleData, VelocityData, Vex, Villager, Vindicator, WallData, WeatherEffect, WetData, WhiteSkeleton, WireAttachmentData, Witch, Wither, WitherSkeleton, WitherSkull, Wolf, Zombie, ZombieHorse, ZombiePigman, ZombieVillager

All Known Implementing Classes:

AbstractBooleanData, AbstractBoundedComparableData, AbstractData, AbstractImmutableBooleanData, AbstractImmutableBoundedComparableData, AbstractImmutableData, AbstractImmutableListData, AbstractImmutableMappedData, AbstractImmutableSingleCatalogData, AbstractImmutableSingleData, AbstractImmutableSingleEnumData, AbstractIntData, AbstractListData, AbstractMappedData, AbstractSingleCatalogData, AbstractSingleData, AbstractSingleEnumData, Location

public interface ValueContainer<C extends ValueContainer<C>>

A ValueContainer is a holder of a particular set of BaseValues. While there exists a CompositeValueStore and ImmutableValueStore, the emphasis of ValueContainer is that it only contains "data". It is not known whether a ValueContainer is mutable or immutable.

Being that a ValueContainer is literally a container of BaseValues, it itself does not contain the underlying values of data. A ValueContainer may not always be parented by another ValueContainer, such as the case for DataManipulators and DataHolders, it is recommended to knowingly understand the fundamental differences between them.

Method Summary

Modifier and Type	Method and Description
C	copy() Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.
<E> Optional<E>	get(Key<? extends BaseValue<E>> key) Attempts to get the underlying value backed by a BaseValue linked to the provided Key.
Set<Key<?>>	getKeys() Gets all applicable Keys for this ValueContainer.
default <E> E	getOrElse(Key<? extends BaseValue<E>> key, E defaultValue) Attempts to get the underlying value if available.
default <E> E	getOrNull(Key<? extends BaseValue<E>> key) Attempts to get the underlying value if available and supported.
<E,V extends BaseValue<E>> Optional<V>	getValue(Key<V> key) Gets the BaseValue for the given Key.
Set<ImmutableValue<?>>	getValues() Gets all applicable BaseValues associated with this ValueContainer.
default <E> E	require(Key<? extends BaseValue<E>> key) Attempts to get the underlying value backed by a BaseValue linked to the provided Key.
default boolean	supports(BaseValue<?> baseValue) Checks if the provided BaseValue is supported.
boolean	supports(Key<?> key) Checks if the given Key is supported by this ValueContainer.

Method Detail

get

<E> Optional<E> get(Key<? extends BaseValue<E>> key)

Attempts to get the underlying value backed by a BaseValue linked to the provided Key. If the Key is not supported, Optional.empty() is returned. It is important to check for support of a Key by either calling supports(BaseValue) or supports(Key).

Type Parameters:

E - The type of value

Parameters:

key - The key linking the

Returns:

The value, if available

require

default <E> E require(Key<? extends BaseValue<E>> key)

Attempts to get the underlying value backed by a BaseValue linked to the provided Key.

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

Type Parameters:

E - The type of value

Parameters:

key - The key

Returns:

The value

Throws:

NoSuchElementException - If the value is not supported or present

getOrNull

@Nullable
default <E> E getOrNull(Key<? extends BaseValue<E>> key)

Attempts to get the underlying value if available and supported. If the BaseValue is not supported whatsoever by this ValueContainer, an exception is thrown.

Type Parameters:

E - The type of value

Parameters:

key - The Key backing the BaseValue

Returns:

The value, or null if not set

getOrElse

default <E> E getOrElse(Key<? extends BaseValue<E>> key,
                        E defaultValue)

Attempts to get the underlying value if available. If the value is not set, the given defaultValue is returned, if the BaseValue is even supported.

Type Parameters:

E - The type of value

Parameters:

key - The key backing the BaseValue

defaultValue - The value to default to if not set

Returns:

The value, or default if not set

getValue

<E,V extends BaseValue<E>> Optional<V> getValue(Key<V> key)

Gets the BaseValue for the given Key.

Type Parameters:

E - The type of the return type

V - The type of value

Parameters:

key - The key linked to the BaseValue

Returns:

The value, if available

supports

boolean supports(Key<?> key)

Checks if the given Key is supported by this ValueContainer.

Parameters:

key - The key to check

Returns:

True if the key and value backed by the key is supported

supports

default boolean supports(BaseValue<?> baseValue)

Checks if the provided BaseValue is supported.

Parameters:

baseValue - The base value to check

Returns:

True if the base value is supported

copy

C copy()

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

Returns:

The new copy

getKeys

Set<Key<?>> getKeys()

Gets all applicable Keys for this ValueContainer. Changes can not be made to the set to alter the ValueContainer, nor can the BaseValues be changed with the provided ImmutableSet.

Returns:

An immutable set of known Keys

getValues

Set<ImmutableValue<?>> getValues()

Gets all applicable BaseValues associated with this ValueContainer. As the data backed by the values are copied, any modifications to the BaseValues will not be reflected onto this ValueContainer.

Returns:

An immutable set of copied values