Dynamic (datafixerupper 4.0.0-SNAPSHOT API)

java.lang.Object
- com.mojang.serialization.DynamicLike<T>
- - com.mojang.serialization.Dynamic<T>

Type Parameters:

T - The type of the serialization form.
```
public class Dynamic<T>
extends DynamicLike<T>
```
Encapsulates the serialized form of a single value. This class allows algorithms to work generically over any serialized type without exposing Object parameters, and enforces the existence of a DynamicOps instance for the particular serialized form. Dynamic also provides an interface similar to DynamicOps for deserializing the contained value.

See Also:

DynamicOps

Field Summary
- Fields inherited from class com.mojang.serialization.DynamicLike
  ops

Constructor Summary

Constructors
Constructor and Description
`Dynamic(DynamicOps<T> ops)` Constructs a new `Dynamic` containing the empty value of the given serialized form.
`Dynamic(DynamicOps<T> ops, T value)` Constructs a new `Dynamic` containing the given value of the serialized form.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataResult<ByteBuffer>`	`asByteBufferOpt()` Coerces and returns the wrapped value as a `ByteBuffer` in a `DataResult`.
`DataResult<IntStream>`	`asIntStreamOpt()` Coerces and returns the wrapped value as a stream of int values in a `DataResult`.
`DataResult<LongStream>`	`asLongStreamOpt()` Coerces and returns the wrapped value as a stream of long values in a `DataResult`.
`DataResult<Stream<(Dynamic<T>,Dynamic<T>)>>`	`asMapOpt()` Coerces and returns the wrapped value as a map of entries in a `DataResult`.
`DataResult<Number>`	`asNumber()` Coerces and returns the wrapped value as a number in a `DataResult`.
`DataResult<Stream<Dynamic<T>>>`	`asStreamOpt()` Coerces and returns the wrapped value as a stream of values in a `DataResult`.
`DataResult<String>`	`asString()` Coerces and returns the wrapped value as a string in a `DataResult`.
`<U> U`	`cast(DynamicOps<U> ops)` Safely casts this `Dynamic` to a more specific type, and returns the contained value.
`<U> Dynamic<U>`	`castTyped(DynamicOps<U> ops)` Safely casts this `Dynamic` to a more specific type.
`<R> Dynamic<R>`	`convert(DynamicOps<R> outOps)` Converts this `Dynamic` to an equivalent object of another serialized form.
`static <S,T> T`	`convert(DynamicOps<S> inOps, DynamicOps<T> outOps, S input)` Converts a raw serialized value from one form to another.
`<A> DataResult<(A,T)>`	`decode(Decoder<? extends A> decoder)` Decodes an object using the given `Decoder`, and returns a `DataResult` containing a pair of the decoded object and the remaining serialized value.
`boolean`	`equals(Object o)`
`OptionalDynamic<T>`	`get(String key)` If the given key is present in the wrapped value, returns the value associated with it, else returns empty.
`DataResult<T>`	`getElement(String key)` If the given key is present in the wrapped value, returns the value associated with it, else returns empty.
`DataResult<T>`	`getElementGeneric(T key)` If the key represented by the given serialized value is present in the wrapped value, returns the value associated with it, else returns empty.
`DataResult<T>`	`getGeneric(T key)` If the key represented by the given serialized value is present in the wrapped value, returns the value associated with it, else returns empty.
`DataResult<Map<Dynamic<T>,Dynamic<T>>>`	`getMapValues()` Partially deserializes the contained value as a map of serialized entries.
`T`	`getValue()` Returns the contained serialized value.
`int`	`hashCode()`
`<V> V`	`into((? super Dynamic<T>) -> ? extends V action)` Applies the given action to this value and returns a result.
`Dynamic<T>`	`map((? super T) -> ? extends T function)` Transforms the wrapped serialized value using the given mapping function.
`OptionalDynamic<T>`	`merge(Dynamic<?> value)` If this object contains a list, appends the given value to it, otherwise returns an empty `OptionalDynamic`.
`OptionalDynamic<T>`	`merge(Dynamic<?> key, Dynamic<?> value)` If this object contains a map, appends the given key-value pair to it, otherwise returns an empty `OptionalDynamic`.
`Dynamic<T>`	`remove(String key)` Removes the entry associated with the given key in the serialized value.
`Dynamic<T>`	`set(String key, Dynamic<?> value)` Adds the given entry to the contained serialized value.
`String`	`toString()`
`Dynamic<T>`	`update(String key, (Dynamic<?>) -> Dynamic<?> function)` Updates an existing entry in the contained serialized value using the given function.
`Dynamic<T>`	`updateGeneric(T key, (T) -> T function)` Updates an existing entry in the contained serialized value using the given function.
`Dynamic<T>`	`updateMapValues(((Dynamic<?>,Dynamic<?>)) -> (Dynamic<?>,Dynamic<?>) updater)` Updates every map entry contained within the serialized value using the given updating function.

Methods inherited from class com.mojang.serialization.DynamicLike
asBoolean, asByte, asByteBuffer, asDouble, asFloat, asInt, asIntStream, asList, asListOpt, asLong, asLongStream, asMap, asMapOpt, asNumber, asShort, asStream, asString, createBoolean, createByte, createByteList, createDouble, createFloat, createInt, createIntList, createList, createLong, createLongList, createMap, createNumeric, createShort, createString, emptyList, emptyMap, getElement, getElementGeneric, getOps, read, readList, readList, readMap, readMap, readMap

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - Dynamic
```
public Dynamic(DynamicOps<T> ops)
```
 Constructs a new Dynamic containing the empty value of the given serialized form.
 
 Parameters:
 
 ops - The DynamicOps instance for the serialized form.
 - Dynamic
```
public Dynamic(DynamicOps<T> ops,
 @Nullable
 T value)
```
 Constructs a new Dynamic containing the given value of the serialized form.
 
 Parameters:
 
 ops - The DynamicOps instance for the serialized form.
 
 value - The value this object should contain. If null, this object will contain the empty value.
- Method Detail
 - getValue
```
public T getValue()
```
 Returns the contained serialized value.
 - map
```
public Dynamic<T> map((? super T) -> ? extends T function)
```
 Transforms the wrapped serialized value using the given mapping function.
 
 Parameters:
 
 function - The function to use to transform the value.
 
 Returns:
 
 A Dynamic containing the new value.
 - castTyped
```
public  Dynamic castTyped(DynamicOps ops)
```
 Safely casts this Dynamic to a more specific type. This is typically used to downcast a Dynamic<?> to a concrete serialized type.
 
 Type Parameters:
 
 U - The type of the serialized form.
 
 Parameters:
 
 ops - The DynamicOps instance for the serialized form.
 
 Returns:
 
 This Dynamic, casted to use the serialized form of the argument.
 
 Throws:
 
 IllegalStateException - If the given DynamicOps does not equal the actual DynamicOps instance used in this object.
 - cast
```
public  U cast(DynamicOps ops)
```
 Safely casts this Dynamic to a more specific type, and returns the contained value. This method is equivalent to castTyped(ops).getValue().
 
 Type Parameters:
 
 U - The type of the serialized form.
 
 Parameters:
 
 ops - The DynamicOps instance for the serialized form.
 
 Returns:
 
 The contained serialized value casted to the type defined by the argument.
 
 Throws:
 
 IllegalStateException - If the given DynamicOps does not equal the actual DynamicOps instance used in this object.
 
 See Also:
 
 castTyped(DynamicOps)
 - merge
```
public OptionalDynamic<T> merge(Dynamic<?> value)
```
 If this object contains a list, appends the given value to it, otherwise returns an empty OptionalDynamic.
 
 Parameters:
 
 value - The value to append to the list contained in this object.
 
 Returns:
 
 An OptionalDynamic containing the merged list, or an empty OptionalDynamic if this value is not a list.
 
 Throws:
 
 IllegalStateException - If value does not use the same serialization form as this object.
 
 See Also:
 
 DynamicOps.mergeToList(Object, Object)
 - merge
```
public OptionalDynamic<T> merge(Dynamic<?> key,
 Dynamic<?> value)
```
 If this object contains a map, appends the given key-value pair to it, otherwise returns an empty OptionalDynamic.
 
 Parameters:
 
 key - The key to merge into the map.
 
 value - The value to merge into the map.
 
 Returns:
 
 An OptionalDynamic containing the merged map, or an empty OptionalDynamic if this value is not a map.
 
 Throws:
 
 IllegalStateException - If either key or value do not use the same serialization form as this object.
 
 See Also:
 
 DynamicOps.mergeToMap(Object, Object, Object)
 - getMapValues
```
public DataResult<Map<Dynamic<T>,Dynamic<T>>> getMapValues()
```
 Partially deserializes the contained value as a map of serialized entries.
 
 Returns:
 
 A DataResult containing the deserialized map, or an error result if the contained serialized value is not a map.
 
 See Also:
 
 DynamicOps.getMapValues(Object)
 - updateMapValues
```
public Dynamic<T> updateMapValues(((Dynamic<?>,Dynamic<?>)) -> (Dynamic<?>,Dynamic<?>) updater)
```
 Updates every map entry contained within the serialized value using the given updating function.
 
 Parameters:
 
 updater - A function to transform the existing key-value pair to a new key-value pair.
 
 Returns:
 
 A Dynamic containing the transformed value. If the contained serialized value is not a map, it is returned unchanged and updater is not called.
 - asNumber
```
public DataResult<Number> asNumber()
```
 Description copied from class: DynamicLike
 
 Coerces and returns the wrapped value as a number in a DataResult.
 
 Specified by:
 
 asNumber in class DynamicLike<T>
 
 See Also:
 
 DynamicOps.getNumberValue(Object)
 - asString
```
public DataResult<String> asString()
```
 Description copied from class: DynamicLike
 
 Coerces and returns the wrapped value as a string in a DataResult.
 
 Specified by:
 
 asString in class DynamicLike<T>
 
 See Also:
 
 DynamicOps.getStringValue(Object)
 - asStreamOpt
```
public DataResult<Stream<Dynamic<T>>> asStreamOpt()
```
 Description copied from class: DynamicLike
 
 Coerces and returns the wrapped value as a stream of values in a DataResult.
 
 Specified by:
 
 asStreamOpt in class DynamicLike<T>
 
 See Also:
 
 DynamicOps.getStream(Object)
 - asMapOpt
```
public DataResult<Stream<(Dynamic<T>,Dynamic<T>)>> asMapOpt()
```
 Description copied from class: DynamicLike
 
 Coerces and returns the wrapped value as a map of entries in a DataResult.
 
 Specified by:
 
 asMapOpt in class DynamicLike<T>
 
 See Also:
 
 DynamicOps.getMapValues(Object)
 - asByteBufferOpt
```
public DataResult<ByteBuffer> asByteBufferOpt()
```
 Description copied from class: DynamicLike
 
 Coerces and returns the wrapped value as a ByteBuffer in a DataResult.
 
 Specified by:
 
 asByteBufferOpt in class DynamicLike<T>
 
 See Also:
 
 DynamicOps.getByteBuffer(Object)
 - asIntStreamOpt
```
public DataResult<IntStream> asIntStreamOpt()
```
 Description copied from class: DynamicLike
 
 Coerces and returns the wrapped value as a stream of int values in a DataResult.
 
 Specified by:
 
 asIntStreamOpt in class DynamicLike<T>
 
 See Also:
 
 DynamicOps.getIntStream(Object)
 - asLongStreamOpt
```
public DataResult<LongStream> asLongStreamOpt()
```
 Description copied from class: DynamicLike
 
 Coerces and returns the wrapped value as a stream of long values in a DataResult.
 
 Specified by:
 
 asLongStreamOpt in class DynamicLike<T>
 
 See Also:
 
 DynamicOps.getLongStream(Object)
 - get
```
public OptionalDynamic<T> get(String key)
```
 Description copied from class: DynamicLike
 
 If the given key is present in the wrapped value, returns the value associated with it, else returns empty.
 
 Specified by:
 
 get in class DynamicLike<T>
 
 Parameters:
 
 key - The key to search for.
 
 Returns:
 
 The value associated with the key, wrapped in a OptionalDynamic.
 - getGeneric
```
public DataResult<T> getGeneric(T key)
```
 Description copied from class: DynamicLike
 
 If the key represented by the given serialized value is present in the wrapped value, returns the value associated with it, else returns empty.
 
 Specified by:
 
 getGeneric in class DynamicLike<T>
 
 Parameters:
 
 key - The key to search for.
 
 Returns:
 
 The value associated with the key, wrapped in a DataResult.
 - remove
```
public Dynamic<T> remove(String key)
```
 Removes the entry associated with the given key in the serialized value.
 
 Parameters:
 
 key - The key to remove from the map.
 
 Returns:
 
 A Dynamic containing the transformed serialized value. If the contained serialized value is not a map, then it is returned unchanged.
 
 See Also:
 
 DynamicOps.remove(Object, String)
 - set
```
public Dynamic<T> set(String key,
 Dynamic<?> value)
```
 Adds the given entry to the contained serialized value.
 
 Parameters:
 
 key - The key to add.
 
 value - The value to add, wrapped in a Dynamic.
 
 Returns:
 
 A Dynamic containing the transformed serialized value. If the contained serialized value is not a map, then it is returned unchanged.
 
 See Also:
 
 DynamicOps.set(Object, String, Object)
 - update
```
public Dynamic<T> update(String key,
 (Dynamic<?>) -> Dynamic<?> function)
```
 Updates an existing entry in the contained serialized value using the given function. If the given key is not present, the function is not called and no entry is added.
 
 Parameters:
 
 key - The key of the entry to update.
 
 function - A function to produce a new value from the existing value.
 
 Returns:
 
 A Dynamic containing the transformed serialized value. If the contained serialized value is not a map, then it is returned unchanged.
 
 See Also:
 
 DynamicOps.update(Object, String, Function)
 - updateGeneric
```
public Dynamic<T> updateGeneric(T key,
 (T) -> T function)
```
 Updates an existing entry in the contained serialized value using the given function. This method is like update(String, Function), expect that it operates on raw serialized values rather than wrapped serialized values.
 
 Parameters:
 
 key - The serialized form of the key of the entry to update.
 
 function - A function to produce a new value from the existing value.
 
 Returns:
 
 A Dynamic containing the transformed serialized value. If the contained serialized value is not a map, then it is returned unchanged.
 
 See Also:
 
 update(String, Function), DynamicOps.updateGeneric(Object, Object, Function)
 - getElement
```
public DataResult<T> getElement(String key)
```
 Description copied from class: DynamicLike
 
 If the given key is present in the wrapped value, returns the value associated with it, else returns empty.
 
 Specified by:
 
 getElement in class DynamicLike<T>
 
 Parameters:
 
 key - The key to search for.
 
 Returns:
 
 The value associated with the key, wrapped in a DataResult.
 
 See Also:
 
 DynamicLike.get(String)
 - getElementGeneric
```
public DataResult<T> getElementGeneric(T key)
```
 Description copied from class: DynamicLike
 
 If the key represented by the given serialized value is present in the wrapped value, returns the value associated with it, else returns empty.
 
 Specified by:
 
 getElementGeneric in class DynamicLike<T>
 
 Parameters:
 
 key - The key to search for.
 
 Returns:
 
 The value associated with the key, wrapped in a DataResult.
 
 See Also:
 
 DynamicLike.getGeneric(Object)
 - equals
```
public boolean equals(Object o)
```
 Overrides:
 
 equals in class Object
 - hashCode
```
public int hashCode()
```
 Overrides:
 
 hashCode in class Object
 - toString
```
public String toString()
```
 Overrides:
 
 toString in class Object
 - convert
```
public <R> Dynamic<R> convert(DynamicOps<R> outOps)
```
 Converts this Dynamic to an equivalent object of another serialized form.
 
 Type Parameters:
 
 R - The type of the new serialized form.
 
 Parameters:
 
 outOps - The DynamicOps instance representing the new serialized form.
 
 Returns:
 
 A Dynamic containing an equivalent value of the new serialized form.
 
 See Also:
 
 DynamicOps.convertTo(DynamicOps, Object)
 - into
```
public <V> V into((? super Dynamic<T>) -> ? extends V action)
```
 Applies the given action to this value and returns a result. The action is passed the value of this.
 
 API Note:
 
 This method is typically used to transform this Dynamic into another type.
 
 Type Parameters:
 
 V - The result type.
 
 Parameters:
 
 action - The action to perform on this dynamic value.
 
 Returns:
 
 The result produced by action.
 - decode
```
public <A> DataResult<(A,T)> decode(Decoder<? extends A> decoder)
```
 Description copied from class: DynamicLike
 
 Decodes an object using the given Decoder, and returns a DataResult containing a pair of the decoded object and the remaining serialized value.
 
 Specified by:
 
 decode in class DynamicLike<T>
 
 Type Parameters:
 
 A - The type of the decoded object.
 
 Parameters:
 
 decoder - The decoder to use.
 
 Returns:
 
 A DataResult containing the decoded object and the remaining serialized value.
 - convert
```
public static <S,T> T convert(DynamicOps<S> inOps,
 DynamicOps<T> outOps,
 S input)
```
 Converts a raw serialized value from one form to another.
 
 API Note:
 
 This method should be used for converting raw serialized values. For converting a Dynamic value, see convert(DynamicOps).
 
 Type Parameters:
 
 S - The type of the serialized form.
 
 T - The type of the new serialized form.
 
 Parameters:
 
 inOps - The DynamicOps instance for the existing serialized value.
 
 outOps - The DynamicOps instance for the new serialized form.
 
 input - The serialized value.
 
 Returns:
 
 A value equivalent to input of the new serialized form.
 
 See Also:
 
 convert(DynamicOps), DynamicOps.convertTo(DynamicOps, Object)

Class Dynamic<T>

Field Summary

Fields inherited from class com.mojang.serialization.DynamicLike

Constructor Summary

Method Summary

Methods inherited from class com.mojang.serialization.DynamicLike

Methods inherited from class java.lang.Object

Constructor Detail

Dynamic

Dynamic

Method Detail

getValue

map

castTyped

cast

merge

merge

getMapValues

updateMapValues

asNumber

asString

asStreamOpt

asMapOpt

asByteBufferOpt

asIntStreamOpt

asLongStreamOpt

get

getGeneric

remove

set

update

updateGeneric

getElement

getElementGeneric

equals

hashCode

toString

convert

into

decode

convert