Package de.eldoria.jacksonbukkit

Class JacksonBukkitModule

java.lang.Object
com.fasterxml.jackson.databind.Module
de.eldoria.jacksonbukkit.JacksonBukkitModule
All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned
Direct Known Subclasses:
JacksonBukkit, JacksonPaper
@Internal public abstract class JacksonBukkitModule extends com.fasterxml.jackson.databind.Module
Base class to implement a bukkit jackson module.

  • Nested Class Summary

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

    com.fasterxml.jackson.databind.Module.SetupContext

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final boolean
    hexColors
    True when colors should be interpreted as hex strings.
    protected final NamespacedKeySerializer.Format
    namespacedKeyFormat
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    JacksonBukkitModule(boolean hexColors, NamespacedKeySerializer.Format namespacedKeyFormat)
    Creates a new jackson bukkit module

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final void
    addDeserializer(com.fasterxml.jackson.databind.module.SimpleDeserializers deserializers)
    Add deserializer to the deserializers
    protected final void
    addSerializer(com.fasterxml.jackson.databind.module.SimpleSerializers serializers)
    Add serializer to the serializers
    abstract String
    getModuleName()
     
    protected abstract void
    registerDeserializer(com.fasterxml.jackson.databind.module.SimpleDeserializers deserializers)
    Register deserializers of the inheriting class.
    protected abstract void
    registerSerializer(com.fasterxml.jackson.databind.module.SimpleSerializers serializers)
    Register serializer of the inheriting class
    void
    setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
     
    com.fasterxml.jackson.core.Version
    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

  • Field Details

    • hexColors

      protected final boolean hexColors
      True when colors should be interpreted as hex strings.

    • namespacedKeyFormat

      protected final NamespacedKeySerializer.Format namespacedKeyFormat

  • Constructor Details

    • JacksonBukkitModule

      public JacksonBukkitModule(boolean hexColors, NamespacedKeySerializer.Format namespacedKeyFormat)
      Creates a new jackson bukkit module
      Parameters:
      hexColors - true to use hex colors

  • Method Details

    • getModuleName

      public abstract String getModuleName()
      Specified by:
      getModuleName in class com.fasterxml.jackson.databind.Module

    • version

      public com.fasterxml.jackson.core.Version version()
      Specified by:
      version in interface com.fasterxml.jackson.core.Versioned
      Specified by:
      version in class com.fasterxml.jackson.databind.Module

    • setupModule

      public void setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
      Specified by:
      setupModule in class com.fasterxml.jackson.databind.Module

    • addSerializer

      protected final void addSerializer(com.fasterxml.jackson.databind.module.SimpleSerializers serializers)
      Add serializer to the serializers
      Parameters:
      serializers - serializers

    • registerSerializer

      protected abstract void registerSerializer(com.fasterxml.jackson.databind.module.SimpleSerializers serializers)
      Register serializer of the inheriting class

      Will be called after default serializer were registered.

      Parameters:
      serializers - serializers

    • addDeserializer

      protected final void addDeserializer(com.fasterxml.jackson.databind.module.SimpleDeserializers deserializers)
      Add deserializer to the deserializers
      Parameters:
      deserializers - deserializers

    • registerDeserializer

      protected abstract void registerDeserializer(com.fasterxml.jackson.databind.module.SimpleDeserializers deserializers)
      Register deserializers of the inheriting class.

      Will be called after default deserializer were registered.

      Parameters:
      deserializers - deserializers