Package org.springframework.hateoas.mediatype.hal

Class Jackson2HalModule

java.lang.Object
com.fasterxml.jackson.databind.Module
com.fasterxml.jackson.databind.module.SimpleModule
org.springframework.hateoas.mediatype.hal.Jackson2HalModule
All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned, Serializable
public class Jackson2HalModule extends com.fasterxml.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 
    Jackson2HalModule.EmbeddedMapper
    Helper to easily map embedded resources and find out whether they were curied.
    static class 
    Jackson2HalModule.HalHandlerInstantiator
    HandlerInstantiator to create HAL-specific serializers, deserializers etc.
    static class 
    Jackson2HalModule.HalLinkListDeserializer
     
    static class 
    Jackson2HalModule.HalLinkListSerializer
    Custom JsonSerializer to render Link instances in HAL compatible JSON.
    static class 
    Jackson2HalModule.HalResourcesDeserializer
     
    static class 
    Jackson2HalModule.HalResourcesSerializer
    Custom JsonSerializer to render EntityModel-Lists in HAL compatible JSON.
    static class 
    Jackson2HalModule.OptionalListJackson2Serializer
    Custom JsonSerializer to render Link instances in HAL compatible JSON.
    static class 
    Jackson2HalModule.TrueOnlyBooleanSerializer
    JsonSerializer to only render Boolean values if they're set to true.

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

    com.fasterxml.jackson.databind.Module.SetupContext

  • Field Summary

    Fields inherited from class com.fasterxml.jackson.databind.module.SimpleModule

    _abstractTypes, _deserializerModifier, _deserializers, _hasExplicitName, _keyDeserializers, _keySerializers, _mixins, _name, _namingStrategy, _serializerModifier, _serializers, _subtypes, _valueInstantiators, _version

  • Constructor Summary

    Constructors
    Constructor
    Description
    Jackson2HalModule()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    isAlreadyRegisteredIn(com.fasterxml.jackson.databind.ObjectMapper mapper)
    Returns whether the module was already registered in the given ObjectMapper.

    Methods inherited from class com.fasterxml.jackson.databind.module.SimpleModule

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

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

    getDependencies

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Jackson2HalModule

      public Jackson2HalModule()

  • Method Details

    • isAlreadyRegisteredIn

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