TextComponentSerializer (MCStructs-text 5-3.3.2-SNAPSHOT API)

java.lang.Object
- com.viaversion.viaversion.libs.mcstructs.text.serializer.TextComponentSerializer

All Implemented Interfaces:

com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking
```
public class TextComponentSerializer
extends java.lang.Object
implements com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking
```
The text component serializer and deserializer wrapper class.
Use the static default fields for a specific minecraft version or create your own serializer/deserializer.

Field Summary

Fields
Modifier and Type	Field and Description
`static TextComponentSerializer`	`LATEST` The latest text component serializer.
`static TextComponentSerializer`	`V1_12` The text component serializer for 1.12 - 1.13. Use the `deserializeReader(String)` method for vanilla like deserialization.
`static TextComponentSerializer`	`V1_14` The text component serializer for 1.14. Use the `deserializeReader(String)` method for vanilla like deserialization.
`static TextComponentSerializer`	`V1_15` The text component serializer for 1.15. Use the `deserializeReader(String)` method for vanilla like deserialization.
`static TextComponentSerializer`	`V1_16` The text component serializer for 1.16. Use the `deserializeReader(String)` method for vanilla like deserialization.
`static TextComponentSerializer`	`V1_17` The text component serializer for 1.17. Use the `deserializeReader(String)` method for vanilla like deserialization.
`static TextComponentSerializer`	`V1_18` The text component serializer for 1.18 - 1.19. Use the `deserializeReader(String)` method for vanilla like deserialization.
`static TextComponentSerializer`	`V1_19_4` The text component serializer for 1.19.4. Use the `deserializeReader(String)` method for vanilla like deserialization.
`static TextComponentSerializer`	`V1_20_3` The text component serializer for 1.20.3.
`static TextComponentSerializer`	`V1_20_5` The text component serializer for 1.20.5.
`static TextComponentSerializer`	`V1_21_2` The text component serializer for 1.21.2.
`static TextComponentSerializer`	`V1_21_4` The text component serializer for 1.21.4.
`static TextComponentSerializer`	`V1_21_5` The text component serializer for 1.21.5.
`static TextComponentSerializer`	`V1_21_6` The text component serializer for 1.21.6.
`static TextComponentSerializer`	`V1_21_9` The text component serializer for 1.21.6.
`static TextComponentSerializer`	`V1_6` The text component serializer for 1.6. Use the `deserialize(String)` and `deserialize(JsonElement)` methods for vanilla like deserialization.
`static TextComponentSerializer`	`V1_7` The text component serializer for 1.7. Use the `deserialize(String)` and `deserialize(JsonElement)` methods for vanilla like deserialization.
`static TextComponentSerializer`	`V1_8` The text component serializer for 1.8. Use the `deserialize(String)` and `deserialize(JsonElement)` methods for vanilla like deserialization.
`static TextComponentSerializer`	`V1_9` The text component serializer for 1.9 - 1.11. Use the `deserializeReader(String)` method for vanilla like deserialization.
`static TextComponentSerializer`	`V26_1` The text component serializer for 26.1.
`static TextComponentSerializer`	`V26_2` The text component serializer for 26.2.

Constructor Summary

Constructors
Constructor and Description
`TextComponentSerializer(java.util.function.Supplier<com.google.gson.Gson> gsonSupplier)`
`TextComponentSerializer(java.util.function.Supplier<com.google.gson.Gson> gsonSupplier, boolean legacyGson)`
`TextComponentSerializer(TextComponentCodec parentCodec, java.util.function.Supplier<com.google.gson.Gson> gsonSupplier)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.function.Consumer<java.lang.String>`	`currentConsumer()`
`TextComponent`	`deserialize(com.google.gson.JsonElement element)` Deserialize a text component from a `JsonElement`. This method is used by minecraft versions 1.6 - 1.8.
`TextComponent`	`deserialize(java.lang.String json)` Deserialize a text component from a json string. This method is used by minecraft versions 1.6 - 1.8. It can deserialize components with comments which newer versions did not support. Example: `{"text":/comment/"Hello World"}`
`TextComponent`	`deserializeLenientReader(java.lang.String json)` Deserialize a text component from a json string. This method is available in minecraft versions 1.9+ but not used for text components. It can deserialize components with comments and trailing data. Example: `{"text":/comment/"Hello World"}` `{"text":"Hello World"}trailing data`
`TextComponent`	`deserializeParser(java.lang.String json)` Deserialize a text component from a json string. This method is used by minecraft versions 1.20.3+.
`TextComponent`	`deserializeReader(java.lang.String json)` Deserialize a text component from a json string. This method is used by minecraft versions 1.9 - 1.20.2. It can not deserialize components with comments which older versions did support.
`TextComponent`	`deserializeReader(java.lang.String json, boolean lenient)` Deserialize a text component from a json string. This method is available in minecraft versions 1.9+ but is only used with `lenient` being false.
`TextComponentSerializer`	`forkIfDefault()`
`com.google.gson.Gson`	`getGson()`
`TextComponentCodec`	`getParentCodec()`
`boolean`	`isCodec()`
`java.lang.String`	`serialize(TextComponent component)` Serialize a text component to a json string.
`com.google.gson.JsonElement`	`serializeJson(TextComponent component)` Serialize a text component to a `JsonElement`.
`void`	`setCurrentConsumer(java.util.function.Consumer<java.lang.String> consumer)`

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

- Field Detail
  - V1_6
```
public static final TextComponentSerializer V1_6
```
    The text component serializer for 1.6.
    Use the deserialize(String) and deserialize(JsonElement) methods for vanilla like deserialization.
  - V1_7
```
public static final TextComponentSerializer V1_7
```
    The text component serializer for 1.7.
    Use the deserialize(String) and deserialize(JsonElement) methods for vanilla like deserialization.
  - V1_8
```
public static final TextComponentSerializer V1_8
```
    The text component serializer for 1.8.
    Use the deserialize(String) and deserialize(JsonElement) methods for vanilla like deserialization.
  - V1_9
```
public static final TextComponentSerializer V1_9
```
    The text component serializer for 1.9 - 1.11.
    Use the deserializeReader(String) method for vanilla like deserialization.
  - V1_12
```
public static final TextComponentSerializer V1_12
```
    The text component serializer for 1.12 - 1.13.
    Use the deserializeReader(String) method for vanilla like deserialization.
  - V1_14
```
public static final TextComponentSerializer V1_14
```
    The text component serializer for 1.14.
    Use the deserializeReader(String) method for vanilla like deserialization.
  - V1_15
```
public static final TextComponentSerializer V1_15
```
    The text component serializer for 1.15.
    Use the deserializeReader(String) method for vanilla like deserialization.
  - V1_16
```
public static final TextComponentSerializer V1_16
```
    The text component serializer for 1.16.
    Use the deserializeReader(String) method for vanilla like deserialization.
  - V1_17
```
public static final TextComponentSerializer V1_17
```
    The text component serializer for 1.17.
    Use the deserializeReader(String) method for vanilla like deserialization.
  - V1_18
```
public static final TextComponentSerializer V1_18
```
    The text component serializer for 1.18 - 1.19.
    Use the deserializeReader(String) method for vanilla like deserialization.
  - V1_19_4
```
public static final TextComponentSerializer V1_19_4
```
    The text component serializer for 1.19.4.
    Use the deserializeReader(String) method for vanilla like deserialization.
  - V1_20_3
```
public static final TextComponentSerializer V1_20_3
```
    The text component serializer for 1.20.3.
  - V1_20_5
```
public static final TextComponentSerializer V1_20_5
```
    The text component serializer for 1.20.5.
  - V1_21_2
```
public static final TextComponentSerializer V1_21_2
```
    The text component serializer for 1.21.2.
  - V1_21_4
```
public static final TextComponentSerializer V1_21_4
```
    The text component serializer for 1.21.4.
  - V1_21_5
```
public static final TextComponentSerializer V1_21_5
```
    The text component serializer for 1.21.5.
  - V1_21_6
```
public static final TextComponentSerializer V1_21_6
```
    The text component serializer for 1.21.6.
  - V1_21_9
```
public static final TextComponentSerializer V1_21_9
```
    The text component serializer for 1.21.6.
  - V26_1
```
public static final TextComponentSerializer V26_1
```
    The text component serializer for 26.1.
  - V26_2
```
public static final TextComponentSerializer V26_2
```
    The text component serializer for 26.2.
  - LATEST
```
public static final TextComponentSerializer LATEST
```
    The latest text component serializer.
- Constructor Detail
  - TextComponentSerializer
```
public TextComponentSerializer(java.util.function.Supplier<com.google.gson.Gson> gsonSupplier)
```
  - TextComponentSerializer
```
public TextComponentSerializer(java.util.function.Supplier<com.google.gson.Gson> gsonSupplier,
                               boolean legacyGson)
```
  - TextComponentSerializer
```
public TextComponentSerializer(TextComponentCodec parentCodec,
                               java.util.function.Supplier<com.google.gson.Gson> gsonSupplier)
```
- Method Detail
  - currentConsumer
```
@Nullable
public java.util.function.Consumer<java.lang.String> currentConsumer()
```
    Specified by:
    
    currentConsumer in interface com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking
  - setCurrentConsumer
```
public void setCurrentConsumer(java.util.function.Consumer<java.lang.String> consumer)
```
    Specified by:
    
    setCurrentConsumer in interface com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking
  - forkIfDefault
```
public TextComponentSerializer forkIfDefault()
```
    Specified by:
    
    forkIfDefault in interface com.viaversion.viaversion.libs.mcstructs.converter.ConsumerTracking
  - getParentCodec
```
@Nullable
public TextComponentCodec getParentCodec()
```
    Returns:
    
    The parent codec of this serializer if it was created using TextComponentCodec.asSerializer()
  - isCodec
```
public boolean isCodec()
```
    Returns:
    
    If this serializer has a parent codec
  - getGson
```
public com.google.gson.Gson getGson()
```
    Returns:
    
    The used gson instance
  - serialize
```
public java.lang.String serialize(TextComponent component)
```
    Serialize a text component to a json string.
    
    Parameters:
    
    component - The component to serialize
    
    Returns:
    
    The json string
  - serializeJson
```
public com.google.gson.JsonElement serializeJson(TextComponent component)
```
    Serialize a text component to a JsonElement.
    
    Parameters:
    
    component - The component to serialize
    
    Returns:
    
    The json element
  - deserialize
```
public TextComponent deserialize(java.lang.String json)
```
    Deserialize a text component from a json string.
    This method is used by minecraft versions 1.6 - 1.8.
    It can deserialize components with comments which newer versions did not support.
    
    Example:
    {"text":/*comment*/"Hello World"}
    
    Parameters:
    
    json - The json string
    
    Returns:
    
    The deserialized text component
  - deserialize
```
public TextComponent deserialize(com.google.gson.JsonElement element)
```
    Deserialize a text component from a JsonElement.
    This method is used by minecraft versions 1.6 - 1.8.
    
    Parameters:
    
    element - The json element
    
    Returns:
    
    The deserialized text component
  - deserializeReader
```
public TextComponent deserializeReader(java.lang.String json)
```
    Deserialize a text component from a json string.
    This method is used by minecraft versions 1.9 - 1.20.2.
    It can not deserialize components with comments which older versions did support.
    
    Parameters:
    
    json - The json string
    
    Returns:
    
    The deserialized text component
  - deserializeParser
```
public TextComponent deserializeParser(java.lang.String json)
```
    Deserialize a text component from a json string.
    This method is used by minecraft versions 1.20.3+.
    
    Parameters:
    
    json - The json string
    
    Returns:
    
    The deserialized text component
  - deserializeLenientReader
```
public TextComponent deserializeLenientReader(java.lang.String json)
```
    Deserialize a text component from a json string.
    This method is available in minecraft versions 1.9+ but not used for text components.
    It can deserialize components with comments and trailing data.
    
    Example:
    {"text":/*comment*/"Hello World"}
    {"text":"Hello World"}trailing data
    
    Parameters:
    
    json - The json string
    
    Returns:
    
    The deserialized text component
  - deserializeReader
```
public TextComponent deserializeReader(java.lang.String json,
                                       boolean lenient)
```
    Deserialize a text component from a json string.
    This method is available in minecraft versions 1.9+ but is only used with lenient being false.
    
    Parameters:
    
    json - The json string
    
    lenient - Whether to use a lenient json reader
    
    Returns:
    
    The deserialized text component

Class TextComponentSerializer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

V1_6

V1_7

V1_8

V1_9

V1_12

V1_14

V1_15

V1_16

V1_17

V1_18

V1_19_4

V1_20_3

V1_20_5

V1_21_2

V1_21_4

V1_21_5

V1_21_6

V1_21_9

V26_1

V26_2

LATEST

Constructor Detail

TextComponentSerializer

TextComponentSerializer

TextComponentSerializer

Method Detail

currentConsumer

setCurrentConsumer

forkIfDefault

getParentCodec

isCodec

getGson

serialize

serializeJson

deserialize

deserialize

deserializeReader

deserializeParser

deserializeLenientReader

deserializeReader