Package dev.vankka.mcdiscordreserializer.minecraft

Class MinecraftSerializer

java.lang.Object

dev.vankka.mcdiscordreserializer.minecraft.MinecraftSerializer

public class MinecraftSerializer
extends java.lang.Object

MinecraftSerializer, for serializing from Discord messages to Minecraft Components.

Author:

Vankka

See Also:

MinecraftSerializerOptions, MinecraftRenderer

Field Summary

Fields

Modifier and Type	Field	Description
static MinecraftSerializer	INSTANCE	Default instance of the MinecraftSerializer, incase that's all you need.

Constructor Summary

Constructors

Constructor	Description
MinecraftSerializer()	Constructor for creating a serializer, with MinecraftSerializerOptions.defaults() and MinecraftSerializerOptions.escapeDefaults() as defaults.
MinecraftSerializer(@NonNull MinecraftSerializerOptions<net.kyori.adventure.text.Component> defaultOptions, @NonNull MinecraftSerializerOptions<java.lang.String> markdownDefaultOptions)	Constructor for creating a serializer, with the specified MinecraftSerializerOptions as defaults.

Method Summary

Modifier and Type	Method	Description
java.lang.String	escapeMarkdown(@NonNull java.lang.String discordMessage)	Escapes the given Discord message of Discord markdown.
java.lang.String	escapeMarkdown(@NonNull java.lang.String discordMessage, @NonNull MinecraftSerializerOptions<java.lang.String> serializerOptions)	Escapes the given Discord message of Discord markdown.
net.kyori.adventure.text.Component	serialize(@NonNull java.lang.String discordMessage)	Serializes Discord formatting (markdown) to a Minecraft Component using this serializer's default options. Use serialize(String, MinecraftSerializerOptions) to fine tune the serialization options.
net.kyori.adventure.text.Component	serialize(@NonNull java.lang.String discordMessage, @NonNull MinecraftSerializerOptions<net.kyori.adventure.text.Component> serializerOptions)	Serializes Discord formatting (markdown) to a Minecraft Component.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final MinecraftSerializer INSTANCE

Default instance of the MinecraftSerializer, incase that's all you need. Using MinecraftSerializer#setDefaultOptions(MinecraftSerializerOptions) and MinecraftSerializer#setMarkdownDefaultOptions(MinecraftSerializerOptions) are not allowed.

Constructor Detail

MinecraftSerializer

public MinecraftSerializer()

Constructor for creating a serializer, with MinecraftSerializerOptions.defaults() and MinecraftSerializerOptions.escapeDefaults() as defaults.

MinecraftSerializer

public MinecraftSerializer(@NonNull
                           @NonNull MinecraftSerializerOptions<net.kyori.adventure.text.Component> defaultOptions,
                           @NonNull
                           @NonNull MinecraftSerializerOptions<java.lang.String> markdownDefaultOptions)

Constructor for creating a serializer, with the specified MinecraftSerializerOptions as defaults.

Parameters:

defaultOptions - the default serializer options (can be overridden on serialize)

See Also:

MinecraftSerializerOptions.defaults(), MinecraftSerializerOptions#MinecraftSerializerOptions(dev.vankka.simpleast.core.parser.Parser, List, List, boolean)

Method Detail

serialize

public net.kyori.adventure.text.Component serialize(@NonNull
                                                    @NonNull java.lang.String discordMessage)

Serializes Discord formatting (markdown) to a Minecraft Component using this serializer's default options.
Use serialize(String, MinecraftSerializerOptions) to fine tune the serialization options.

Parameters:

discordMessage - a Discord markdown message

Returns:

the Discord message formatted to a Minecraft TextComponent

serialize

public net.kyori.adventure.text.Component serialize(@NonNull
                                                    @NonNull java.lang.String discordMessage,
                                                    @NonNull
                                                    @NonNull MinecraftSerializerOptions<net.kyori.adventure.text.Component> serializerOptions)

Serializes Discord formatting (markdown) to a Minecraft Component.

Parameters:

discordMessage - a Discord markdown message

serializerOptions - The options to use for this serialization

Returns:

the Discord message formatted to a Minecraft TextComponent

See Also:

MinecraftSerializerOptions.defaults(), MinecraftSerializerOptions#MinecraftSerializerOptions(dev.vankka.simpleast.core.parser.Parser, List, List, boolean)

escapeMarkdown

public java.lang.String escapeMarkdown(@NonNull
                                       @NonNull java.lang.String discordMessage)

Escapes the given Discord message of Discord markdown. Should include the entire message (not just a part) to be effective.

Parameters:

discordMessage - the Discord message

Returns:

the Discord markdown message with markdown escaped

See Also:

MinecraftSerializerOptions.escapeDefaults(), escapeMarkdown(String, MinecraftSerializerOptions)

escapeMarkdown

public java.lang.String escapeMarkdown(@NonNull
                                       @NonNull java.lang.String discordMessage,
                                       @NonNull
                                       @NonNull MinecraftSerializerOptions<java.lang.String> serializerOptions)

Escapes the given Discord message of Discord markdown. Should include the entire message (not just a part) to be effective.

Parameters:

discordMessage - the Discord message

serializerOptions - options for this escape

Returns:

the Discord markdown message with markdown escaped

See Also:

MinecraftSerializerOptions.escapeDefaults(), escapeMarkdown(String)