Package dev.vankka.mcdiscordreserializer.minecraft

Class MinecraftSerializerOptions<O>

java.lang.Object

dev.vankka.mcdiscordreserializer.minecraft.MinecraftSerializerOptions<O>

Type Parameters:

O - the type of the result produced with the renderers

public class MinecraftSerializerOptions<O>
extends java.lang.Object

Options for MinecraftSerializers.

Constructor Summary

Constructors

Constructor	Description
MinecraftSerializerOptions()

Method Summary

Modifier and Type	Method	Description
MinecraftSerializerOptions<O>	addRenderer(int index, NodeRenderer<O> renderer)	Creates a instance of MinecraftSerializerOptions with the given renderer added at the given index, keep in mind a default renderer is always present.
MinecraftSerializerOptions<O>	addRenderer(NodeRenderer<O> renderer)	Creates a instance of MinecraftSerializerOptions with the given renderer added.
static MinecraftSerializerOptions<net.kyori.adventure.text.Component>	defaults()	Creates the default MinecraftSerializerOptions for serialization.
static MinecraftSerializerOptions<java.lang.String>	escapeDefaults()	Creates the default MinecraftSerializerOptions for escaping markdown.
java.util.List<NodeRenderer<O>>	getRenderers()	Returns the renderers for this options instance.
MinecraftSerializerOptions<O>	removeRenderer(NodeRenderer<O> renderer)	Creates a instance of MinecraftSerializerOptions without the given renderer.

Methods inherited from class java.lang.Object

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

Constructor Detail

MinecraftSerializerOptions

public MinecraftSerializerOptions()

Method Detail

defaults

public static MinecraftSerializerOptions<net.kyori.adventure.text.Component> defaults()

Creates the default MinecraftSerializerOptions for serialization.

Returns:

the default MinecraftSerializerOptions.

escapeDefaults

public static MinecraftSerializerOptions<java.lang.String> escapeDefaults()

Creates the default MinecraftSerializerOptions for escaping markdown.

Returns:

the default MinecraftSerializerOptions.

addRenderer

public MinecraftSerializerOptions<O> addRenderer(NodeRenderer<O> renderer)

Creates a instance of MinecraftSerializerOptions with the given renderer added.

Parameters:

renderer - the renderer to add

Returns:

the new instance of options

Throws:

java.lang.IllegalArgumentException - if the renderer is already included in this options instance or is of type DefaultMinecraftRenderer

See Also:

List.add(Object)

addRenderer

public MinecraftSerializerOptions<O> addRenderer(int index,
                                                 NodeRenderer<O> renderer)

Creates a instance of MinecraftSerializerOptions with the given renderer added at the given index, keep in mind a default renderer is always present.

Parameters:

renderer - the renderer to add

index - the index to add the renderer at

Returns:

the new instance of options

Throws:

java.lang.IllegalArgumentException - if the renderer is already included in this options instance or is of type DefaultMinecraftRenderer

See Also:

List.add(int, Object)

removeRenderer

public MinecraftSerializerOptions<O> removeRenderer(NodeRenderer<O> renderer)

Creates a instance of MinecraftSerializerOptions without the given renderer.

Parameters:

renderer - the renderer to remove

Returns:

the new instance of options

Throws:

java.lang.IllegalArgumentException - if the renderer is not included in this options instance

getRenderers

public java.util.List<NodeRenderer<O>> getRenderers()

Returns the renderers for this options instance.

Returns:

the ordered unmodifiable list of