Module tools.jackson.databind

Package tools.jackson.databind.ser.jdk

Class UUIDSerializer

java.lang.Object

tools.jackson.databind.ValueSerializer<T>

tools.jackson.databind.ser.std.StdSerializer<T>

tools.jackson.databind.ser.std.StdScalarSerializer<UUID>

tools.jackson.databind.ser.jdk.UUIDSerializer

All Implemented Interfaces:

JsonFormatVisitable

public class UUIDSerializer
extends StdScalarSerializer<UUID>

Specialized ValueSerializer to output UUIDs. Beyond optimized access and writing of textual representation (which is the default handling in most cases), it will alternatively allow serialization using raw binary output (as 16-byte block) if underlying data format has efficient means to access that.

Nested Class Summary

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

ValueSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
protected final Boolean	_asBinary	Configuration setting that indicates if serialization as binary (native or Base64-encoded) has been forced; null means "use default heuristic"

Fields inherited from class tools.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Modifier	Constructor	Description
	UUIDSerializer()
protected	UUIDSerializer(Boolean asBinary)

Method Summary

Modifier and Type	Method	Description
protected boolean	_writeAsBinary(SerializationContext ctxt)
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)	Default implementation specifies no format.
ValueSerializer<?>	createContextual(SerializationContext serializers, BeanProperty property)	Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed).
boolean	isEmpty(SerializationContext prov, UUID value)	Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
void	serialize(UUID value, JsonGenerator gen, SerializationContext ctxt)	Method that can be called to ask implementation to serialize values of type this serializer handles.

Methods inherited from class tools.jackson.databind.ser.std.StdScalarSerializer

serializeWithType

Methods inherited from class tools.jackson.databind.ser.std.StdSerializer

_neitherNull, _nonEmpty, _wrapIOFailure, acceptJsonFormatVisitorForBinary, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

Methods inherited from class tools.jackson.databind.ValueSerializer

getDelegatee, isUnwrappingSerializer, properties, replaceDelegatee, resolve, unwrappingSerializer, usesObjectId, withFilterId, withFormatOverrides, withIgnoredProperties

Methods inherited from class java.lang.Object

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

Field Details

_asBinary

protected final Boolean _asBinary

Configuration setting that indicates if serialization as binary (native or Base64-encoded) has been forced; null means "use default heuristic"

Constructor Details

UUIDSerializer

public UUIDSerializer()

UUIDSerializer

protected UUIDSerializer(Boolean asBinary)

Method Details

isEmpty

public boolean isEmpty(SerializationContext prov,
 UUID value)

Description copied from class: ValueSerializer

Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).

Default implementation will consider only null values to be empty.

Overrides:

isEmpty in class ValueSerializer<UUID>

createContextual

public ValueSerializer<?> createContextual(SerializationContext serializers,
 BeanProperty property)

Description copied from class: ValueSerializer

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.

Overrides:

createContextual in class ValueSerializer<UUID>

Parameters:

serializers - Context to use for accessing config, other serializers

property - Property (defined by one or more accessors - field or method - used for accessing logical property value) for which serializer is used to be used; or, `null` for root value (or in cases where caller does not have this information, which is handled as root value case).

Returns:

Serializer to use for serializing values of specified property; may be this instance or a new instance.

serialize

public void serialize(UUID value,
 JsonGenerator gen,
 SerializationContext ctxt)
               throws JacksonException

Description copied from class: ValueSerializer

Method that can be called to ask implementation to serialize values of type this serializer handles.

Specified by:

serialize in class StdSerializer<UUID>

Parameters:

value - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

ctxt - Context that can be used to get serializers for serializing Objects value contains, if any.

Throws:

JacksonException

_writeAsBinary

protected boolean _writeAsBinary(SerializationContext ctxt)

acceptJsonFormatVisitor

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
 JavaType typeHint)

Description copied from class: StdSerializer

Default implementation specifies no format. This behavior is usually overriden by custom serializers.

Specified by:

acceptJsonFormatVisitor in interface JsonFormatVisitable

Overrides:

acceptJsonFormatVisitor in class StdScalarSerializer<UUID>

typeHint - Type of element (entity like property) being visited