Class UUIDSerializer

java.lang.Object

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

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

com.fasterxml.jackson.databind.ser.std.StdScalarSerializer<UUID>

com.fasterxml.jackson.databind.ser.std.UUIDSerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, ContextualSerializer, Serializable

public class UUIDSerializer
extends StdScalarSerializer<UUID>
implements ContextualSerializer

Specialized JsonSerializer 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.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class JsonSerializer

JsonSerializer.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 StdSerializer

_handledType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected boolean	_writeAsBinary(com.fasterxml.jackson.core.JsonGenerator g)
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)	Default implementation specifies no format.
JsonSerializer<?>	createContextual(SerializerProvider serializers, BeanProperty property)	Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.
boolean	isEmpty(SerializerProvider 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, com.fasterxml.jackson.core.JsonGenerator gen, SerializerProvider provider)	Method that can be called to ask implementation to serialize values of type this serializer handles.

Methods inherited from class StdScalarSerializer

getSchema, serializeWithType

Methods inherited from class StdSerializer

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

Methods inherited from class JsonSerializer

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

Methods inherited from class 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"

Since:

2.11.3

Constructor Details

UUIDSerializer

public UUIDSerializer()

UUIDSerializer

protected UUIDSerializer(Boolean asBinary)

Since:

2.11.3

Method Details

isEmpty

public boolean isEmpty(SerializerProvider prov,
 UUID value)

Description copied from class: JsonSerializer

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.

NOTE: replaces JsonSerializer.isEmpty(Object), which was deprecated in 2.5

Overrides:

isEmpty in class JsonSerializer<UUID>

createContextual

public JsonSerializer<?> createContextual(SerializerProvider serializers,
 BeanProperty property)
                                   throws JsonMappingException

Description copied from interface: ContextualSerializer

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. 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.

Specified by:

createContextual in interface ContextualSerializer

Parameters:

serializers - Serializer provider to use for accessing config, other serializers

property - Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)

Returns:

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

Throws:

JsonMappingException

serialize

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

Description copied from class: JsonSerializer

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

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

Throws:

IOException

_writeAsBinary

protected boolean _writeAsBinary(com.fasterxml.jackson.core.JsonGenerator g)

acceptJsonFormatVisitor

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
 JavaType typeHint)
                             throws JsonMappingException

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>

Parameters:

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

Throws:

JsonMappingException