org.spongepowered.api.data.manipulator

Interface ImmutableDataManipulator<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>

Type Parameters:

I - The type of immutable data manipulator

M - The type of mutable data manipulator

All Superinterfaces:

DataSerializable, ValueContainer<I>

All Known Subinterfaces:

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, 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, ImmutableVariantData<E,I,M>, ImmutableVehicleData, ImmutableVelocityData, ImmutableWallData, ImmutableWetData, ImmutableWireAttachmentData

All Known Implementing Classes:

AbstractImmutableBooleanData, AbstractImmutableBoundedComparableData, AbstractImmutableData, AbstractImmutableListData, AbstractImmutableMappedData, AbstractImmutableSingleCatalogData, AbstractImmutableSingleData, AbstractImmutableSingleEnumData

public interface ImmutableDataManipulator<I extends ImmutableDataManipulator<I,M>,M extends DataManipulator<M,I>>
extends DataSerializable, ValueContainer<I>

An ImmutableDataManipulator is an immutable ValueContainer such that once it is created, any BaseValues exist as ImmutableValues. Any modification methods result in new instances of the same typed ImmutableDataManipulator.

As with DataManipulator, it is always possible to translate back and forth between mutable and immutable with asMutable() and DataManipulator.asImmutable().

Method Summary

Modifier and Type	Method and Description
M	asMutable() Gets a DataManipulator copy of this ImmutableDataManipulator such that all backed ImmutableValues are copied into their Value counterparts.
default I	copy() Creates a clone copy of this ValueContainer as a new ValueContainer such that all the BaseValues are safely duplicated to the new instance.
default Optional<I>	with(BaseValue<?> value) Creates a new ImmutableDataManipulator with the provided BaseValue provided that the BaseValue is supported by this ImmutableDataManipulator.
default <E> Optional<I>	with(Key<? extends BaseValue<E>> key, E value) Creates a new ImmutableDataManipulator with the provided value if the Key is supported by this ImmutableDataManipulator without exception.

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

getContentVersion, toContainer

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

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

Method Detail

with

default <E> Optional<I> with(Key<? extends BaseValue<E>> key,
                             E value)

Creates a new ImmutableDataManipulator with the provided value if the Key is supported by this ImmutableDataManipulator without exception.

Type Parameters:

E - The type of value

Parameters:

key - The key to use

value - The value to set

Returns:

The new immutable data manipulator, if compatible

with

default Optional<I> with(BaseValue<?> value)

Creates a new ImmutableDataManipulator with the provided BaseValue provided that the BaseValue is supported by this ImmutableDataManipulator. A simple check can be called for ValueContainer.supports(BaseValue) prior to ensure Optional.isPresent() returns true.

Parameters:

value - The value to set

Returns:

The new immutable data manipulator, if compatible

copy

default I copy()

Description copied from interface: ValueContainer

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

Specified by:

copy in interface ValueContainer<I extends ImmutableDataManipulator<I,M>>

Returns:

The new copy

asMutable

M asMutable()

Gets a DataManipulator copy of this ImmutableDataManipulator such that all backed ImmutableValues are copied into their Value counterparts. Any changes to this ImmutableDataManipulator will NOT be reflected on the returned DataManipulator and vice versa.

Returns:

This ImmutableDataManipulator's data copied into a DataManipulator