Class Jackson2Serializers.EnumTranslatingSerializer

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<Enum>

com.fasterxml.jackson.databind.ser.std.StdSerializer<Enum>

org.springframework.data.rest.webmvc.json.Jackson2Serializers.EnumTranslatingSerializer

All Implemented Interfaces:

com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable, com.fasterxml.jackson.databind.jsonschema.SchemaAware, Serializable, JsonSchemaPropertyCustomizer

Enclosing class:

Jackson2Serializers

public static class Jackson2Serializers.EnumTranslatingSerializer
extends com.fasterxml.jackson.databind.ser.std.StdSerializer<Enum>
implements JsonSchemaPropertyCustomizer

An enum serializer to translate raw enum values into values resolved through a resource bundle.

Since:

2.4

Author:

Oliver Gierke

See Also:

• Serialized Form

Nested Class Summary

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

com.fasterxml.jackson.databind.JsonSerializer.None

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Constructor	Description
EnumTranslatingSerializer(EnumTranslator translator)	Creates a new Jackson2Serializers.EnumTranslatingSerializer using the given EnumTranslator.

Method Summary

Modifier and Type	Method	Description
JsonSchema.JsonSchemaProperty	customize(JsonSchema.JsonSchemaProperty property, TypeInformation<?> type)	Returns the customized JsonSchema.JsonSchemaProperty based on the given one and the given type.
void	serialize(Enum value, com.fasterxml.jackson.core.JsonGenerator gen, com.fasterxml.jackson.databind.SerializerProvider provider)

Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

_neitherNull, _nonEmpty, acceptJsonFormatVisitor, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

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

getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, serializeWithType, unwrappingSerializer, usesObjectId, withFilterId, withIgnoredProperties

Methods inherited from class Object

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

Constructor Details

EnumTranslatingSerializer

public EnumTranslatingSerializer(EnumTranslator translator)

Creates a new Jackson2Serializers.EnumTranslatingSerializer using the given EnumTranslator.

Parameters:

translator - must not be null.

Method Details

serialize

public void serialize(Enum value,
 com.fasterxml.jackson.core.JsonGenerator gen,
 com.fasterxml.jackson.databind.SerializerProvider provider)
               throws IOException

Specified by:

serialize in class com.fasterxml.jackson.databind.ser.std.StdSerializer<Enum>

Throws:

IOException

customize

public JsonSchema.JsonSchemaProperty customize(JsonSchema.JsonSchemaProperty property,
 TypeInformation<?> type)

Description copied from interface: JsonSchemaPropertyCustomizer

Returns the customized JsonSchema.JsonSchemaProperty based on the given one and the given type.

Specified by:

customize in interface JsonSchemaPropertyCustomizer

Parameters:

property - will never be null.

type - will never be null.

Returns: