Package org.spongepowered.api.data

Interface SerializableDataHolder

All Superinterfaces:

CopyableDataHolder, DataHolder, DataSerializable, ValueContainer

All Known Subinterfaces:

Aerial, Ageable, Agent, Ambient, Animal, Aquatic, Archetype<S,E>, AreaEffectCloud, ArmorStand, Arrow, ArrowEntity, Banner, Barrel, Bat, Beacon, Bed, Bee, Beehive, Bell, BlastFurnace, Blaze, BlockEntity, BlockEntityArchetype, BlockOccupiedMinecart, BlockSnapshot, BlockState, Boat, Boss, BrewingStand, Campfire, CarrierBlockEntity, CarrierMinecart<M>, Cat, CaveSpider, Chest, ChestMinecart, Chicken, ClientPlayer, Cod, CommandBlock, CommandBlockMinecart, Comparator, ComplexLiving<T>, ComplexLivingPart<P>, Conduit, Cow, Creature, Creeper, DamagingProjectile, DaylightDetector, Dispenser, Dolphin, Donkey, DragonFireball, Dropper, Drowned, Egg, ElderGuardian, EnchantmentTable, EndCrystal, EnderChest, EnderDragon, EnderDragonPart, Enderman, Endermite, EnderPearl, EndGateway, EndPortal, Entity, EntityArchetype, EntitySnapshot, EntityTargetingProjectile, Evoker, EvokerFangs, ExperienceBottle, ExperienceOrb, Explosive, ExplosiveFireball, EyeOfEnder, FallingBlock, FireballEntity, FireworkRocket, Fish, FishingBobber, FluidStack, FluidStackSnapshot, FluidState, Fox, Furnace, FurnaceBlockEntity, FurnaceMinecart, FusedExplosive, Ghast, Giant, Golem, Guardian, Hanging, Hoglin, Hopper, HopperMinecart, Horse, HorseLike, Hostile, Human, Humanoid, Husk, Illager, Illusioner, IronGolem, Item, ItemFrame, ItemStack, ItemStackSnapshot, Jigsaw, Jukebox, LeashKnot, Lectern, LightningBolt, Living, Llama, LlamaLike, LlamaSpit, LocalPlayer, LocatableBlock, LocatableSnapshot<T>, MagmaCube, Minecart, MinecartLike, MobSpawner, Monster, Mooshroom, Mule, NameableBlockEntity, NameableCarrierBlockEntity, Ocelot, PackHorse, Painting, Panda, Parrot, Patroller, Phantom, Pig, Piglin, PiglinBrute, PiglinLike, Pillager, Piston, Player, PolarBear, Potion, PrimedTNT, Projectile, Pufferfish, Rabbit, Raider, Ranger, Ravager, RemotePlayer, Salmon, SchoolingFish, SerializableDataHolder.Immutable<I>, SerializableDataHolder.Mutable, ServerPlayer, Sheep, Shulker, ShulkerBox, ShulkerBullet, Sign, Silverfish, Sittable, Skeleton, SkeletonHorse, SkeletonLike, Skull, Slime, SmallFireball, Smoker, Snowball, SnowGolem, Spawner, SpawnerMinecart, SpectralArrow, Spellcaster, Spider, Squid, State<S>, Stray, Strider, StructureBlock, TameableAnimal, TameableHorse, TNTMinecart, Trader, TraderLlama, TrappedChest, Trident, TropicalFish, Turtle, Vehicle, Vex, Villager, Vindicator, WanderingTrader, WeatherEffect, Witch, Wither, WitherSkeleton, WitherSkull, Wolf, Zoglin, Zombie, ZombieHorse, ZombieLike, ZombieVillager, ZombifiedPiglin

public interface SerializableDataHolder
extends DataSerializable, CopyableDataHolder

Represents a DataHolder that can be serialized into a DataContainer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SerializableDataHolder.Immutable<I extends SerializableDataHolder.Immutable<I>>
static interface	SerializableDataHolder.Mutable

Method Summary

Modifier and Type	Method	Description
SerializableDataHolder	copy()	Creates a clone copy of this CopyableDataHolder as a new CopyableDataHolder such that all the Values are safely duplicated to the new instance.
boolean	validateRawData(DataView container)	Validates the container with known data required to set the raw data to this SerializableDataHolder.

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

contentVersion, toContainer

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

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

Method Detail

validateRawData

boolean validateRawData(DataView container)

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

This validation should be checked prior to calling SerializableDataHolder.Mutable.setRawData(DataView) or SerializableDataHolder.Immutable.withRawData(DataView) to avoid exceptions.

Parameters:

container - The raw data to validate

Returns:

True if the data is valid

copy

SerializableDataHolder copy()

Description copied from interface: CopyableDataHolder

Creates a clone copy of this CopyableDataHolder as a new CopyableDataHolder such that all the Values are safely duplicated to the new instance. It is not guaranteed that the returning container is of the same type as this container.

Specified by:

copy in interface CopyableDataHolder

Returns:

The new copy