Class StdArraySerializers.ByteArraySerializer

java.lang.Object

org.codehaus.jackson.map.JsonSerializer<byte[]>

org.codehaus.jackson.map.ser.std.SerializerBase<byte[]>

org.codehaus.jackson.map.ser.std.StdArraySerializers.ByteArraySerializer

All Implemented Interfaces:

SchemaAware

Enclosing class:

StdArraySerializers

public static final class StdArraySerializers.ByteArraySerializer
extends SerializerBase<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, can not use AsArraySerializer as base

Nested Class Summary

Nested classes/interfaces inherited from class JsonSerializer

JsonSerializer.None

Field Summary

Fields inherited from class SerializerBase

_handledType

Constructor Summary

Constructors

Constructor	Description
ByteArraySerializer()

Method Summary

Modifier and Type	Method	Description
JsonNode	getSchema(SerializerProvider provider, Type typeHint)	Note: since Jackson 1.9, default implementation claims type is "string"
void	serialize(byte[] value, JsonGenerator jgen, SerializerProvider provider)	Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(byte[] value, JsonGenerator jgen, 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 SerializerBase

createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow, wrapAndThrow, wrapAndThrow

Methods inherited from class JsonSerializer

isUnwrappingSerializer, unwrappingSerializer

Methods inherited from class Object

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

Constructor Details

ByteArraySerializer

public ByteArraySerializer()

Method Details

serialize

public void serialize(byte[] value,
 JsonGenerator jgen,
 SerializerProvider provider)
               throws IOException,
JsonGenerationException

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

Parameters:

value - Value to serialize; can not be null.

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

JsonGenerationException

serializeWithType

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

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 ignore serialization of type information, and just calls JsonSerializer.serialize(T, JsonGenerator, SerializerProvider): serializers that can embed type information should override this to implement actual handling. Most common such handling is done by something like:

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

Overrides:

serializeWithType in class JsonSerializer<byte[]>

Parameters:

value - Value to serialize; can not be null.

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

JsonGenerationException

getSchema

public JsonNode getSchema(SerializerProvider provider,
 Type typeHint)

Description copied from class: SerializerBase

Note: since Jackson 1.9, default implementation claims type is "string"

Specified by:

getSchema in interface SchemaAware

Overrides:

getSchema in class SerializerBase<byte[]>

Parameters:

provider - The serializer provider.

typeHint - A hint about the type.

Returns:

Json-schema for this serializer.