Package org.springframework.hateoas.mediatype.hal

Class HalJacksonModule

java.lang.Object
tools.jackson.databind.JacksonModule
tools.jackson.databind.module.SimpleModule
org.springframework.hateoas.mediatype.hal.HalJacksonModule
All Implemented Interfaces:
Serializable, tools.jackson.core.Versioned
public class HalJacksonModule extends tools.jackson.databind.module.SimpleModule
Jackson 2 module implementation to render Link and RepresentationModel instances in HAL compatible JSON.
Author:
Alexander Baetz, Oliver Gierke, Jeffrey Walraven
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    HalJacksonModule.EmbeddedMapper
    Helper to easily map embedded resources and find out whether they were curied.
    static class 
    HalJacksonModule.HalHandlerInstantiator
    HandlerInstantiator to create HAL-specific serializers, deserializers etc.
    static class 
    HalJacksonModule.HalLinkListDeserializer
     
    static class 
    HalJacksonModule.HalLinkListSerializer
    Custom ValueSerializer to render Link instances in HAL compatible JSON.
    static class 
    HalJacksonModule.HalResourcesDeserializer
     
    static class 
    HalJacksonModule.HalResourcesSerializer
    Custom ValueSerializer to render EntityModel-Lists in HAL compatible JSON.
    static class 
    HalJacksonModule.OptionalListJackson2Serializer
    Custom ValueSerializer to render Link instances in HAL compatible JSON.
    static class 
    HalJacksonModule.TrueOnlyBooleanSerializer
    ValueSerializer to only render Boolean values if they're set to true.

    Nested classes/interfaces inherited from class tools.jackson.databind.JacksonModule

    tools.jackson.databind.JacksonModule.SetupContext

  • Field Summary

    Fields inherited from class tools.jackson.databind.module.SimpleModule

    _abstractTypes, _defaultNullKeySerializer, _defaultNullValueSerializer, _deserializerModifier, _deserializers, _id, _keyDeserializers, _keySerializers, _mixins, _name, _namingStrategy, _serializerModifier, _serializers, _subtypes, _valueInstantiators, _version

  • Constructor Summary

    Constructors
    Constructor
    Description
    HalJacksonModule()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    isAlreadyRegisteredIn(tools.jackson.databind.json.JsonMapper mapper)
    Returns whether the module was already registered in the given JsonMapper.

    Methods inherited from class tools.jackson.databind.module.SimpleModule

    _checkNotNull, addAbstractTypeMapping, addDeserializer, addKeyDeserializer, addKeySerializer, addSerializer, addSerializer, addValueInstantiator, getModuleName, getRegistrationId, registerSubtypes, registerSubtypes, registerSubtypes, setAbstractTypes, setDefaultNullKeySerializer, setDefaultNullValueSerializer, setDeserializerModifier, setDeserializers, setKeyDeserializers, setKeySerializers, setMixInAnnotation, setNamingStrategy, setSerializerModifier, setSerializers, setupModule, setValueInstantiators, version

    Methods inherited from class tools.jackson.databind.JacksonModule

    getDependencies

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • HalJacksonModule

      public HalJacksonModule()

  • Method Details

    • isAlreadyRegisteredIn

      public static boolean isAlreadyRegisteredIn(tools.jackson.databind.json.JsonMapper mapper)
      Returns whether the module was already registered in the given JsonMapper.
      Parameters:
      mapper - must not be null.
      Returns: