TextComponentCodec (MCStructs-text 2.5.5 API)

java.lang.Object
- net.lenni0451.mcstructs.text.serializer.TextComponentCodec

Direct Known Subclasses:

TextComponentCodec_v1_20_5
```
@ParametersAreNonnullByDefault
public class TextComponentCodec
extends java.lang.Object
```
The text component serializer and deserializer wrapper class for multiple types of input and output.
Use the static default fields for a specific minecraft version or create your own serializer/deserializer.

This class will now be used for implementations of new minecraft versions (1.20.3+) instead of the TextComponentSerializer class because components can now be serialized to nbt.
Backwards compatibility is supported through the asSerializer() method. The fields in TextComponentSerializer will still be updated using this wrapper method.

Field Summary

Fields
Modifier and Type	Field and Description
`static TextComponentCodec`	`LATEST` The latest text codec.
`static TextComponentCodec`	`V1_20_3` The text codec for 1.20.3.
`static TextComponentCodec_v1_20_5`	`V1_20_5` The text codec for 1.20.5.
`static TextComponentCodec_v1_21_2`	`V1_21_2` The text codec for 1.21.2.
`static TextComponentCodec_v1_21_4`	`V1_21_4` The text codec for 1.21.4.

Constructor Summary

Constructors
Constructor and Description
TextComponentCodec(java.util.function.Supplier<net.lenni0451.mcstructs.snbt.SNbtSerializer<net.lenni0451.mcstructs.nbt.tags.CompoundTag>> sNbtSerializerSupplier, java.util.function.BiFunction<TextComponentCodec,net.lenni0451.mcstructs.snbt.SNbtSerializer<net.lenni0451.mcstructs.nbt.tags.CompoundTag>,ITextComponentSerializer<com.google.gson.JsonElement>> jsonSerializerSupplier, java.util.function.BiFunction<TextComponentCodec,net.lenni0451.mcstructs.snbt.SNbtSerializer<net.lenni0451.mcstructs.nbt.tags.CompoundTag>,ITextComponentSerializer<net.lenni0451.mcstructs.nbt.INbtTag>> nbtSerializerSupplier)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TextComponentSerializer`	`asSerializer()`
`ATextComponent`	`deserialize(net.lenni0451.mcstructs.nbt.INbtTag nbt)` Deserialize a text component from a `INbtTag`.
`ATextComponent`	`deserialize(com.google.gson.JsonElement json)` Deserialize a text component from a `JsonElement`.
`ATextComponent`	`deserializeJson(java.lang.String json)` Deserialize a text component from a json string.
`ATextComponent`	`deserializeJsonReader(java.lang.String json)` Deserialize a text component from a json string.
`ATextComponent`	`deserializeJsonTree(com.google.gson.JsonElement element)` Deserialize a text component from a `JsonElement`.
`ATextComponent`	`deserializeLenientJson(java.lang.String json)` Deserialize a text component from a json string.
`ATextComponent`	`deserializeNbt(java.lang.String nbt)` Deserialize a text component from a nbt string.
`ATextComponent`	`deserializeNbtTree(net.lenni0451.mcstructs.nbt.INbtTag nbt)` Deserialize a text component from a `INbtTag`.
`ITextComponentSerializer<com.google.gson.JsonElement>`	`getJsonSerializer()`
`ITextComponentSerializer<net.lenni0451.mcstructs.nbt.INbtTag>`	`getNbtSerializer()`
`java.lang.String`	`serializeJsonString(ATextComponent component)` Serialize a text component to a json string.
`com.google.gson.JsonElement`	`serializeJsonTree(ATextComponent component)` Serialize a text component to a `JsonElement`.
`net.lenni0451.mcstructs.nbt.INbtTag`	`serializeNbt(ATextComponent component)` Serialize a text component to a `INbtTag`.
`java.lang.String`	`serializeNbtString(ATextComponent component)` Serialize a text component to a nbt string.

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

- Field Detail
  - V1_20_3
```
public static final TextComponentCodec V1_20_3
```
    The text codec for 1.20.3.
  - V1_20_5
```
public static final TextComponentCodec_v1_20_5 V1_20_5
```
    The text codec for 1.20.5.
    If you have access to minecraft data, it is recommended to implement the TextComponentCodec_v1_20_5 class yourself instead of using this codec.
  - V1_21_2
```
public static final TextComponentCodec_v1_21_2 V1_21_2
```
    The text codec for 1.21.2.
    If you have access to minecraft data, it is recommended to implement the TextComponentCodec_v1_21_2 class yourself instead of using this codec.
  - V1_21_4
```
public static final TextComponentCodec_v1_21_4 V1_21_4
```
    The text codec for 1.21.4.
    If you have access to minecraft data, it is recommended to implement the TextComponentCodec_v1_21_4 class yourself instead of using this codec.
  - LATEST
```
public static final TextComponentCodec LATEST
```
    The latest text codec.
- Constructor Detail
  - TextComponentCodec
```
public TextComponentCodec(java.util.function.Supplier<net.lenni0451.mcstructs.snbt.SNbtSerializer<net.lenni0451.mcstructs.nbt.tags.CompoundTag>> sNbtSerializerSupplier,
                          java.util.function.BiFunction<TextComponentCodec,net.lenni0451.mcstructs.snbt.SNbtSerializer<net.lenni0451.mcstructs.nbt.tags.CompoundTag>,ITextComponentSerializer<com.google.gson.JsonElement>> jsonSerializerSupplier,
                          java.util.function.BiFunction<TextComponentCodec,net.lenni0451.mcstructs.snbt.SNbtSerializer<net.lenni0451.mcstructs.nbt.tags.CompoundTag>,ITextComponentSerializer<net.lenni0451.mcstructs.nbt.INbtTag>> nbtSerializerSupplier)
```
- Method Detail
  - getJsonSerializer
```
public ITextComponentSerializer<com.google.gson.JsonElement> getJsonSerializer()
```
    Returns:
    
    The used json serializer/deserializer
  - getNbtSerializer
```
public ITextComponentSerializer<net.lenni0451.mcstructs.nbt.INbtTag> getNbtSerializer()
```
    Returns:
    
    The used nbt serializer/deserializer
  - deserializeJson
```
public ATextComponent deserializeJson(java.lang.String json)
```
    Deserialize a text component from a json string.
    
    Parameters:
    
    json - The json string
    
    Returns:
    
    The deserialized text component
  - deserializeJsonReader
```
public ATextComponent deserializeJsonReader(java.lang.String json)
```
    Deserialize a text component from a json string.
    A JsonReader will be used to parse the json string.
    
    Parameters:
    
    json - The json string
    
    Returns:
    
    The deserialized text component
  - deserializeLenientJson
```
public ATextComponent deserializeLenientJson(java.lang.String json)
```
    Deserialize a text component from a json string.
    A JsonReader will be used to parse the json string.
    
    Parameters:
    
    json - The json string
    
    Returns:
    
    The deserialized text component
  - deserializeNbt
```
public ATextComponent deserializeNbt(java.lang.String nbt)
```
    Deserialize a text component from a nbt string.
    
    Parameters:
    
    nbt - The nbt string
    
    Returns:
    
    The deserialized text component
  - deserializeJsonTree
```
public ATextComponent deserializeJsonTree(@Nullable
                                          com.google.gson.JsonElement element)
```
    Deserialize a text component from a JsonElement.
    
    Parameters:
    
    element - The json element
    
    Returns:
    
    The deserialized text component
  - deserializeNbtTree
```
public ATextComponent deserializeNbtTree(@Nullable
                                         net.lenni0451.mcstructs.nbt.INbtTag nbt)
```
    Deserialize a text component from a INbtTag.
    
    Parameters:
    
    nbt - The nbt tag
    
    Returns:
    
    The deserialized text component
  - deserialize
```
public ATextComponent deserialize(com.google.gson.JsonElement json)
```
    Deserialize a text component from a JsonElement.
    This method does not check for null values.
    
    Parameters:
    
    json - The json element
    
    Returns:
    
    The deserialized text component
  - deserialize
```
public ATextComponent deserialize(net.lenni0451.mcstructs.nbt.INbtTag nbt)
```
    Deserialize a text component from a INbtTag.
    This method does not check for null values.
    
    Parameters:
    
    nbt - The nbt tag
    
    Returns:
    
    The deserialized text component
  - serializeJsonTree
```
public com.google.gson.JsonElement serializeJsonTree(ATextComponent component)
```
    Serialize a text component to a JsonElement.
    
    Parameters:
    
    component - The text component
    
    Returns:
    
    The serialized json element
  - serializeNbt
```
public net.lenni0451.mcstructs.nbt.INbtTag serializeNbt(ATextComponent component)
```
    Serialize a text component to a INbtTag.
    
    Parameters:
    
    component - The text component
    
    Returns:
    
    The serialized nbt tag
  - serializeJsonString
```
public java.lang.String serializeJsonString(ATextComponent component)
```
    Serialize a text component to a json string.
    
    Parameters:
    
    component - The text component
    
    Returns:
    
    The serialized json string
  - serializeNbtString
```
public java.lang.String serializeNbtString(ATextComponent component)
```
    Serialize a text component to a nbt string.
    
    Parameters:
    
    component - The text component
    
    Returns:
    
    The serialized nbt string
  - asSerializer
```
public TextComponentSerializer asSerializer()
```
    Returns:
    
    A wrapper for this codec to use it as a TextComponentSerializer.

Class TextComponentCodec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

V1_20_3

V1_20_5

V1_21_2

V1_21_4

LATEST

Constructor Detail

TextComponentCodec

Method Detail

getJsonSerializer

getNbtSerializer

deserializeJson

deserializeJsonReader

deserializeLenientJson

deserializeNbt

deserializeJsonTree

deserializeNbtTree

deserialize

deserialize

serializeJsonTree

serializeNbt

serializeJsonString

serializeNbtString

asSerializer