com.fasterxml.jackson.databind.ser.std

Class ByteArraySerializer

java.lang.Object

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

com.fasterxml.jackson.databind.ser.std.StdSerializer<byte[]>

com.fasterxml.jackson.databind.ser.std.ByteArraySerializer

All Implemented Interfaces:

JsonFormatVisitable, SchemaAware, Serializable

public class ByteArraySerializer
extends StdSerializer<byte[]>

Unlike other integral number array serializers, we do not just print out byte values as numbers. Instead, we assume that it would make more sense to output content as base64 encoded bytes (using default base64 encoding).

NOTE: since it is NOT serialized as an array, cannot use AsArraySerializer as base

NOTE: since 2.6, has been a main-level class; earlier was embedded in StdArraySerializers.

See Also:

Serialized Form

Nested Class Summary

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

JsonSerializer.None

Field Summary

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

_handledType

Constructor Summary

Constructors

Constructor and Description
ByteArraySerializer()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.
JsonNode	getSchema(SerializerProvider provider, Type typeHint) Default implementation simply claims type is "string"; usually overriden by custom serializers.
boolean	isEmpty(SerializerProvider prov, byte[] value) Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
void	serialize(byte[] value, JsonGenerator g, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(byte[] value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

Methods inherited from class com.fasterxml.jackson.databind.ser.std.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 com.fasterxml.jackson.databind.JsonSerializer

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteArraySerializer

public ByteArraySerializer()

Method Detail

isEmpty

public boolean isEmpty(SerializerProvider prov,
              byte[] 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<byte[]>

serialize

public void serialize(byte[] value,
             JsonGenerator g,
             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<byte[]>

Parameters:

value - Value to serialize; can not be null.

g - 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

serializeWithType

public void serializeWithType(byte[] value,
                     JsonGenerator g,
                     SerializerProvider provider,
                     TypeSerializer typeSer)
                       throws IOException

Description copied from class: JsonSerializer

Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

Default implementation will throw UnsupportedOperationException to indicate that proper type handling needs to be implemented.

For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like:

  // note: method to call depends on whether this type is serialized as JSON scalar, object or Array!
  typeSer.writeTypePrefixForScalar(value, gen);
  serialize(value, gen, provider);
  typeSer.writeTypeSuffixForScalar(value, gen);

and implementations for type serialized as JSON Arrays or Objects would differ slightly, as START-ARRAY/END-ARRAY and START-OBJECT/END-OBJECT pairs need to be properly handled with respect to serializing of contents.

Overrides:

serializeWithType in class JsonSerializer<byte[]>

Parameters:

value - Value to serialize; can not be null.

g - Generator used to output resulting Json content

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

typeSer - Type serializer to use for including type information

Throws:

IOException

getSchema

public JsonNode getSchema(SerializerProvider provider,
                 Type typeHint)

Description copied from class: StdSerializer

Default implementation simply claims type is "string"; usually overriden by custom serializers.

Specified by:

getSchema in interface SchemaAware

Overrides:

getSchema in class StdSerializer<byte[]>

Parameters:

provider - The serializer provider.

typeHint - A hint about the type.

Returns:

Json-schema for this serializer.

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 StdSerializer<byte[]>

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

Throws:

JsonMappingException