org.spongepowered.api.data

Interface DataHolder

All Superinterfaces:

CompositeValueStore<DataHolder,DataManipulator<?,?>>, DataSerializable, PropertyHolder, ValueContainer<DataHolder>

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, 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 DataHolder
extends DataSerializable, PropertyHolder, CompositeValueStore<DataHolder,DataManipulator<?,?>>

A data holder object allows the access of additional data on the object that is not simply expressed by its basic type.

Method Summary

Modifier and Type	Method and Description
void	setRawData(DataView container) Attempts to set all data of this DataHolder according to the DataContainer's held information.
boolean	validateRawData(DataView container) Validates the container with known data required to set the raw data to this DataHolder.

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

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

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

Method Detail

validateRawData

boolean validateRawData(DataView container)

Validates the container with known data required to set the raw data to this DataHolder. If the container is incomplete or contains invalid data, false is returned.

This validation should be checked prior to calling setRawData(DataView) to avoid exceptions.

Parameters:

container - The raw data to validate

Returns:

True if the data is valid

setRawData

void setRawData(DataView container)
         throws InvalidDataException

Attempts to set all data of this DataHolder according to the DataContainer's held information. Using this to modify known DataManipulator is unsupported and if the data is invalid, an InvalidDataException is thrown.

This setter is used to provide setting custom data that is not represented by the Data API, including forge mods and other unknown data. Attempts at validating known DataManipulators contained in the data container are made with the assumption that all necessary data exists.

Parameters:

container - A container containing all raw data to set on this data holder

Throws:

InvalidDataException - If the container is missing or has invalid data that this holder will refuse