Package de.eldoria.jacksonbukkit

Class JacksonPaper

java.lang.Object

com.fasterxml.jackson.databind.Module

de.eldoria.jacksonbukkit.JacksonBukkitModule

de.eldoria.jacksonbukkit.JacksonPaper

All Implemented Interfaces:

Versioned

public class JacksonPaper
extends JacksonBukkitModule

Class adding support for classes implementing ConfigurationSerializable.

• Vector
• BlockVector
• Color
• ItemStack
• PotionEffect
• FireworkEffect
• Pattern
• BoundingBox
• AttributeModifier
• Location

It also provides some additional serialization for:

• NamespacedKey
• OfflinePlayer
• Component

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.Module

Module.SetupContext

Field Summary

Fields inherited from class de.eldoria.jacksonbukkit.JacksonBukkitModule

hexColors

Constructor Summary

Constructors

Constructor	Description
JacksonPaper()	Create a new JacksonPaper module.
JacksonPaper(boolean hexColors, boolean legacyItemStackSerialization, @Nullable JsonDeserializer<net.kyori.adventure.text.Component> componentDeserializer, @Nullable JsonSerializer<net.kyori.adventure.text.Component> componentSerializer)	Create a new JacksonPaper module.

Method Summary

Modifier and Type	Method	Description
static JacksonPaperBuilder	builder()	Get a new builder to create a JacksonPaper module.
String	getModuleName()
protected void	registerDeserializer(SimpleDeserializers deserializers)	Register deserializers of the inheriting class.
protected void	registerSerializer(SimpleSerializers serializers)	Register serializer of the inheriting class

Methods inherited from class de.eldoria.jacksonbukkit.JacksonBukkitModule

addDeserializer, addSerializer, setupModule, version

Methods inherited from class com.fasterxml.jackson.databind.Module

getDependencies, getTypeId

Methods inherited from class java.lang.Object

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

Constructor Details

JacksonPaper

@Internal
public JacksonPaper(boolean hexColors,
 boolean legacyItemStackSerialization,
 @Nullable
 @Nullable JsonDeserializer<net.kyori.adventure.text.Component> componentDeserializer,
 @Nullable
 @Nullable JsonSerializer<net.kyori.adventure.text.Component> componentSerializer)

Create a new JacksonPaper module.

Parameters:

hexColors - true to serialize colors as hex by default

legacyItemStackSerialization - true to use spigot based serialization

JacksonPaper

@Internal
public JacksonPaper()

Create a new JacksonPaper module.

Method Details

builder

public static JacksonPaperBuilder builder()

Get a new builder to create a JacksonPaper module.

Returns:

builder instance

getModuleName

public String getModuleName()

Specified by:

getModuleName in class JacksonBukkitModule

registerSerializer

protected void registerSerializer(SimpleSerializers serializers)

Description copied from class: JacksonBukkitModule

Register serializer of the inheriting class

Will be called after default serializer were registered.

Specified by:

registerSerializer in class JacksonBukkitModule

Parameters:

serializers - serializers

registerDeserializer

protected void registerDeserializer(SimpleDeserializers deserializers)

Description copied from class: JacksonBukkitModule

Register deserializers of the inheriting class.

Will be called after default deserializer were registered.

Specified by:

registerDeserializer in class JacksonBukkitModule

Parameters:

deserializers - deserializers