TextComponentCodec (MCStructs-text 3.2.0 API)

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

```
@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	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`	The text codec for 1.20.5.
`static TextComponentCodec`	`V1_21_2`	The text codec for 1.21.2.
`static TextComponentCodec`	`V1_21_4`	The text codec for 1.21.4.
`static TextComponentCodec`	`V1_21_5`	The text codec for 1.21.5.
`static TextComponentCodec`	`V1_21_6`	The text codec for 1.21.6.
`static TextComponentCodec`	`V1_21_9`	The text codec for 1.21.9.

Constructor Summary

Constructors
Constructor	Description
TextComponentCodec(java.util.function.Supplier<net.lenni0451.mcstructs.snbt.SNbt<net.lenni0451.mcstructs.nbt.tags.CompoundTag>> sNbtSupplier, java.util.function.Supplier<net.lenni0451.mcstructs.converter.codec.Codec<TextComponent>> textCodec, java.util.function.Supplier<net.lenni0451.mcstructs.converter.codec.Codec<Style>> styleCodec, net.lenni0451.mcstructs.converter.DataConverter<com.google.gson.JsonElement> jsonConverter, net.lenni0451.mcstructs.converter.DataConverter<net.lenni0451.mcstructs.nbt.NbtTag> nbtConverter)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TextComponentSerializer`	`asSerializer()`
`TextComponent`	`deserialize(com.google.gson.JsonElement json)`	Deserialize a text component from a `JsonElement`.
`TextComponent`	`deserialize(net.lenni0451.mcstructs.nbt.NbtTag nbt)`	Deserialize a text component from a `NbtTag`.
`TextComponent`	`deserializeJson(java.lang.String json)`	Deserialize a text component from a json string.
`TextComponent`	`deserializeJsonReader(java.lang.String json)`	Deserialize a text component from a json string.
`TextComponent`	`deserializeJsonTree(com.google.gson.JsonElement element)`	Deserialize a text component from a `JsonElement`.
`TextComponent`	`deserializeLenientJson(java.lang.String json)`	Deserialize a text component from a json string.
`TextComponent`	`deserializeNbt(java.lang.String nbt)`	Deserialize a text component from a nbt string.
`TextComponent`	`deserializeNbtTree(net.lenni0451.mcstructs.nbt.NbtTag nbt)`	Deserialize a text component from a `NbtTag`.
`net.lenni0451.mcstructs.converter.DataConverter<com.google.gson.JsonElement>`	`getJsonConverter()`
`net.lenni0451.mcstructs.converter.DataConverter<net.lenni0451.mcstructs.nbt.NbtTag>`	`getNbtConverter()`
`net.lenni0451.mcstructs.converter.codec.Codec<Style>`	`getStyleCodec()`
`net.lenni0451.mcstructs.converter.codec.Codec<TextComponent>`	`getTextCodec()`
`java.lang.String`	`serializeJsonString(TextComponent component)`	Serialize a text component to a json string.
`com.google.gson.JsonElement`	`serializeJsonTree(TextComponent component)`	Serialize a text component to a `JsonElement`.
`java.lang.String`	`serializeNbtString(TextComponent component)`	Serialize a text component to a nbt string.
`net.lenni0451.mcstructs.nbt.NbtTag`	`serializeNbtTree(TextComponent component)`	Serialize a text component to a `NbtTag`.
`TextComponentCodec`	`withVerifier(TextVerifier verifier)`	Create a new text component codec with the given text verifier.

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
```
    The text codec for 1.20.5.
  - V1_21_2
```
public static final TextComponentCodec V1_21_2
```
    The text codec for 1.21.2.
  - V1_21_4
```
public static final TextComponentCodec V1_21_4
```
    The text codec for 1.21.4.
  - V1_21_5
```
public static final TextComponentCodec V1_21_5
```
    The text codec for 1.21.5.
  - V1_21_6
```
public static final TextComponentCodec V1_21_6
```
    The text codec for 1.21.6.
  - V1_21_9
```
public static final TextComponentCodec V1_21_9
```
    The text codec for 1.21.9.
  - LATEST
```
public static final TextComponentCodec LATEST
```
    The latest text codec.
- Constructor Detail
  - TextComponentCodec
```
public TextComponentCodec(java.util.function.Supplier<net.lenni0451.mcstructs.snbt.SNbt<net.lenni0451.mcstructs.nbt.tags.CompoundTag>> sNbtSupplier,
                          java.util.function.Supplier<net.lenni0451.mcstructs.converter.codec.Codec<TextComponent>> textCodec,
                          java.util.function.Supplier<net.lenni0451.mcstructs.converter.codec.Codec<Style>> styleCodec,
                          net.lenni0451.mcstructs.converter.DataConverter<com.google.gson.JsonElement> jsonConverter,
                          net.lenni0451.mcstructs.converter.DataConverter<net.lenni0451.mcstructs.nbt.NbtTag> nbtConverter)
```
- Method Detail
  - getTextCodec
```
public net.lenni0451.mcstructs.converter.codec.Codec<TextComponent> getTextCodec()
```
    Returns:
    
    The used text codec
  - getStyleCodec
```
public net.lenni0451.mcstructs.converter.codec.Codec<Style> getStyleCodec()
```
    Returns:
    
    The used style codec
  - getJsonConverter
```
public net.lenni0451.mcstructs.converter.DataConverter<com.google.gson.JsonElement> getJsonConverter()
```
    Returns:
    
    The used json converter
  - getNbtConverter
```
public net.lenni0451.mcstructs.converter.DataConverter<net.lenni0451.mcstructs.nbt.NbtTag> getNbtConverter()
```
    Returns:
    
    The used nbt converter
  - withVerifier
```
public TextComponentCodec withVerifier(TextVerifier verifier)
```
    Create a new text component codec with the given text verifier.
    The verifier is used to check if the text component is valid during serialization/deserialization.
    By default, no verifier is used and all text components are valid.
    
    Parameters:
    
    verifier - The text verifier
    
    Returns:
    
    The new text component codec
  - deserializeJson
```
public TextComponent 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 TextComponent 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 TextComponent 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 TextComponent 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 TextComponent 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 TextComponent deserializeNbtTree(@Nullable
                                        net.lenni0451.mcstructs.nbt.NbtTag nbt)
```
    Deserialize a text component from a NbtTag.
    
    Parameters:
    
    nbt - The nbt tag
    
    Returns:
    
    The deserialized text component
  - deserialize
```
public TextComponent 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 TextComponent deserialize(net.lenni0451.mcstructs.nbt.NbtTag nbt)
```
    Deserialize a text component from a NbtTag.
    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(TextComponent component)
```
    Serialize a text component to a JsonElement.
    
    Parameters:
    
    component - The text component
    
    Returns:
    
    The serialized json element
  - serializeNbtTree
```
public net.lenni0451.mcstructs.nbt.NbtTag serializeNbtTree(TextComponent component)
```
    Serialize a text component to a NbtTag.
    
    Parameters:
    
    component - The text component
    
    Returns:
    
    The serialized nbt tag
  - serializeJsonString
```
public java.lang.String serializeJsonString(TextComponent 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(TextComponent 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

V1_21_5

V1_21_6

V1_21_9

LATEST

Constructor Detail

TextComponentCodec

Method Detail

getTextCodec

getStyleCodec

getJsonConverter

getNbtConverter

withVerifier

deserializeJson

deserializeJsonReader

deserializeLenientJson

deserializeNbt

deserializeJsonTree

deserializeNbtTree

deserialize

deserialize

serializeJsonTree

serializeNbtTree

serializeJsonString

serializeNbtString

asSerializer