com.fasterxml.jackson.databind.ser.std.StdArraySerializers Maven / Gradle / Ivy
Show all versions of jackson-databind Show documentation
package com.fasterxml.jackson.databind.ser.std;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.HashMap;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.core.type.WritableTypeId;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.annotation.JacksonStdImpl;
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper;
import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes;
import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.fasterxml.jackson.databind.ser.ContainerSerializer;
import com.fasterxml.jackson.databind.type.TypeFactory;
/**
* Dummy container class to group standard homogenous array serializer implementations
* (primitive arrays and String array).
*/
@SuppressWarnings("serial")
public class StdArraySerializers
{
protected final static HashMap> _arraySerializers =
new HashMap>();
static {
// Arrays of various types (including common object types)
_arraySerializers.put(boolean[].class.getName(), new StdArraySerializers.BooleanArraySerializer());
_arraySerializers.put(byte[].class.getName(), new ByteArraySerializer());
_arraySerializers.put(char[].class.getName(), new StdArraySerializers.CharArraySerializer());
_arraySerializers.put(short[].class.getName(), new StdArraySerializers.ShortArraySerializer());
_arraySerializers.put(int[].class.getName(), new StdArraySerializers.IntArraySerializer());
_arraySerializers.put(long[].class.getName(), new StdArraySerializers.LongArraySerializer());
_arraySerializers.put(float[].class.getName(), new StdArraySerializers.FloatArraySerializer());
_arraySerializers.put(double[].class.getName(), new StdArraySerializers.DoubleArraySerializer());
}
protected StdArraySerializers() { }
/**
* Accessor for checking to see if there is a standard serializer for
* given primitive value type.
*/
public static JsonSerializer findStandardImpl(Class cls) {
return _arraySerializers.get(cls.getName());
}
/*
****************************************************************
/* Intermediate base classes
****************************************************************
*/
/**
* Intermediate base class used for cases where we may add
* type information (excludes boolean/int/double arrays).
*/
protected abstract static class TypedPrimitiveArraySerializer
extends ArraySerializerBase
{
protected TypedPrimitiveArraySerializer(Class cls) {
super(cls);
}
protected TypedPrimitiveArraySerializer(TypedPrimitiveArraySerializer src,
BeanProperty prop, Boolean unwrapSingle) {
super(src, prop, unwrapSingle);
}
// 01-Dec-2016, tatu: Only now realized that due strong typing of Java arrays,
// we cannot really ever have value type serializers
@Override
public final ContainerSerializer _withValueTypeSerializer(TypeSerializer vts) {
// throw exception or just do nothing?
return this;
}
}
/*
/****************************************************************
/* Concrete serializers, arrays
/****************************************************************
*/
@JacksonStdImpl
public static class BooleanArraySerializer
extends ArraySerializerBase
{
// as above, assuming no one re-defines primitive/wrapper types
@SuppressWarnings("deprecation")
private final static JavaType VALUE_TYPE = TypeFactory.defaultInstance().uncheckedSimpleType(Boolean.class);
public BooleanArraySerializer() { super(boolean[].class); }
protected BooleanArraySerializer(BooleanArraySerializer src,
BeanProperty prop, Boolean unwrapSingle) {
super(src, prop, unwrapSingle);
}
@Override
public JsonSerializer _withResolved(BeanProperty prop, Boolean unwrapSingle) {
return new BooleanArraySerializer(this, prop, unwrapSingle);
}
/**
* Booleans never add type info; hence, even if type serializer is suggested,
* we'll ignore it...
*/
@Override
public ContainerSerializer _withValueTypeSerializer(TypeSerializer vts) {
return this;
}
@Override
public JavaType getContentType() {
return VALUE_TYPE;
}
@Override
public JsonSerializer getContentSerializer() {
// 14-Jan-2012, tatu: We could refer to an actual serializer if absolutely necessary
return null;
}
@Override
public boolean isEmpty(SerializerProvider prov, boolean[] value) {
return value.length == 0;
}
@Override
public boolean hasSingleElement(boolean[] value) {
return (value.length == 1);
}
@Override
public final void serialize(boolean[] value, JsonGenerator g, SerializerProvider provider) throws IOException
{
final int len = value.length;
if ((len == 1) && _shouldUnwrapSingle(provider)) {
serializeContents(value, g, provider);
return;
}
g.writeStartArray(value, len);
serializeContents(value, g, provider);
g.writeEndArray();
}
@Override
public void serializeContents(boolean[] value, JsonGenerator g, SerializerProvider provider)
throws IOException
{
for (int i = 0, len = value.length; i < len; ++i) {
g.writeBoolean(value[i]);
}
}
@Override
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
{
ObjectNode o = createSchemaNode("array", true);
o.set("items", createSchemaNode("boolean"));
return o;
}
@Override
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
throws JsonMappingException
{
visitArrayFormat(visitor, typeHint, JsonFormatTypes.BOOLEAN);
}
}
@JacksonStdImpl
public static class ShortArraySerializer extends TypedPrimitiveArraySerializer
{
// as above, assuming no one re-defines primitive/wrapper types
@SuppressWarnings("deprecation")
private final static JavaType VALUE_TYPE = TypeFactory.defaultInstance().uncheckedSimpleType(Short.TYPE);
public ShortArraySerializer() { super(short[].class); }
public ShortArraySerializer(ShortArraySerializer src, BeanProperty prop,
Boolean unwrapSingle) {
super(src, prop, unwrapSingle);
}
@Override
public JsonSerializer _withResolved(BeanProperty prop,Boolean unwrapSingle) {
return new ShortArraySerializer(this, prop, unwrapSingle);
}
@Override
public JavaType getContentType() {
return VALUE_TYPE;
}
@Override
public JsonSerializer getContentSerializer() {
// 14-Jan-2012, tatu: We could refer to an actual serializer if absolutely necessary
return null;
}
@Override
public boolean isEmpty(SerializerProvider prov, short[] value) {
return value.length == 0;
}
@Override
public boolean hasSingleElement(short[] value) {
return (value.length == 1);
}
@Override
public final void serialize(short[] value, JsonGenerator g, SerializerProvider provider) throws IOException
{
final int len = value.length;
if ((len == 1) && _shouldUnwrapSingle(provider)) {
serializeContents(value, g, provider);
return;
}
g.writeStartArray(value, len);
serializeContents(value, g, provider);
g.writeEndArray();
}
@SuppressWarnings("cast")
@Override
public void serializeContents(short[] value, JsonGenerator g, SerializerProvider provider)
throws IOException
{
for (int i = 0, len = value.length; i < len; ++i) {
g.writeNumber((int)value[i]);
}
}
@Override
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
{
//no "short" type defined by json
ObjectNode o = createSchemaNode("array", true);
return o.set("items", createSchemaNode("integer"));
}
@Override
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
throws JsonMappingException
{
visitArrayFormat(visitor, typeHint, JsonFormatTypes.INTEGER);
}
}
/**
* Character arrays are different from other integral number arrays in that
* they are most likely to be textual data, and should be written as
* Strings, not arrays of entries.
*
* NOTE: since it is NOT serialized as an array, cannot use AsArraySerializer as base
*/
@JacksonStdImpl
public static class CharArraySerializer extends StdSerializer
{
public CharArraySerializer() { super(char[].class); }
@Override
public boolean isEmpty(SerializerProvider prov, char[] value) {
return value.length == 0;
}
@Override
public void serialize(char[] value, JsonGenerator g, SerializerProvider provider)
throws IOException
{
// [JACKSON-289] allows serializing as 'sparse' char array too:
if (provider.isEnabled(SerializationFeature.WRITE_CHAR_ARRAYS_AS_JSON_ARRAYS)) {
g.writeStartArray(value, value.length);
_writeArrayContents(g, value);
g.writeEndArray();
} else {
g.writeString(value, 0, value.length);
}
}
@Override
public void serializeWithType(char[] value, JsonGenerator g, SerializerProvider provider,
TypeSerializer typeSer)
throws IOException
{
// [JACKSON-289] allows serializing as 'sparse' char array too:
final boolean asArray = provider.isEnabled(SerializationFeature.WRITE_CHAR_ARRAYS_AS_JSON_ARRAYS);
WritableTypeId typeIdDef;
if (asArray) {
typeIdDef = typeSer.writeTypePrefix(g,
typeSer.typeId(value, JsonToken.START_ARRAY));
_writeArrayContents(g, value);
} else { // default is to write as simple String
typeIdDef = typeSer.writeTypePrefix(g,
typeSer.typeId(value, JsonToken.VALUE_STRING));
g.writeString(value, 0, value.length);
}
typeSer.writeTypeSuffix(g, typeIdDef);
}
private final void _writeArrayContents(JsonGenerator g, char[] value)
throws IOException
{
for (int i = 0, len = value.length; i < len; ++i) {
g.writeString(value, i, 1);
}
}
@Override
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
{
ObjectNode o = createSchemaNode("array", true);
ObjectNode itemSchema = createSchemaNode("string");
itemSchema.put("type", "string");
return o.set("items", itemSchema);
}
@Override
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
throws JsonMappingException
{
visitArrayFormat(visitor, typeHint, JsonFormatTypes.STRING);
}
}
@JacksonStdImpl
public static class IntArraySerializer extends ArraySerializerBase
{
// as above, assuming no one re-defines primitive/wrapper types
@SuppressWarnings("deprecation")
private final static JavaType VALUE_TYPE = TypeFactory.defaultInstance().uncheckedSimpleType(Integer.TYPE);
public IntArraySerializer() { super(int[].class); }
/**
* @since 2.6
*/
protected IntArraySerializer(IntArraySerializer src,
BeanProperty prop, Boolean unwrapSingle) {
super(src, prop, unwrapSingle);
}
@Override
public JsonSerializer _withResolved(BeanProperty prop, Boolean unwrapSingle) {
return new IntArraySerializer(this, prop, unwrapSingle);
}
/**
* Ints never add type info; hence, even if type serializer is suggested,
* we'll ignore it...
*/
@Override
public ContainerSerializer _withValueTypeSerializer(TypeSerializer vts) {
return this;
}
@Override
public JavaType getContentType() {
return VALUE_TYPE;
}
@Override
public JsonSerializer getContentSerializer() {
// 14-Jan-2012, tatu: We could refer to an actual serializer if absolutely necessary
return null;
}
@Override
public boolean isEmpty(SerializerProvider prov, int[] value) {
return value.length == 0;
}
@Override
public boolean hasSingleElement(int[] value) {
return (value.length == 1);
}
@Override
public final void serialize(int[] value, JsonGenerator g, SerializerProvider provider) throws IOException
{
final int len = value.length;
if ((len == 1) && _shouldUnwrapSingle(provider)) {
serializeContents(value, g, provider);
return;
}
// 11-May-2016, tatu: As per [core#277] we have efficient `writeArray(...)` available
g.writeArray(value, 0, value.length);
}
@Override
public void serializeContents(int[] value, JsonGenerator g, SerializerProvider provider)
throws IOException
{
for (int i = 0, len = value.length; i < len; ++i) {
g.writeNumber(value[i]);
}
}
@Override
public JsonNode getSchema(SerializerProvider provider, Type typeHint) {
return createSchemaNode("array", true).set("items", createSchemaNode("integer"));
}
@Override
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
{
visitArrayFormat(visitor, typeHint, JsonFormatTypes.INTEGER);
}
}
@JacksonStdImpl
public static class LongArraySerializer extends TypedPrimitiveArraySerializer
{
// as above, assuming no one re-defines primitive/wrapper types
@SuppressWarnings("deprecation")
private final static JavaType VALUE_TYPE = TypeFactory.defaultInstance().uncheckedSimpleType(Long.TYPE);
public LongArraySerializer() { super(long[].class); }
public LongArraySerializer(LongArraySerializer src, BeanProperty prop,
Boolean unwrapSingle) {
super(src, prop, unwrapSingle);
}
@Override
public JsonSerializer _withResolved(BeanProperty prop,Boolean unwrapSingle) {
return new LongArraySerializer(this, prop, unwrapSingle);
}
@Override
public JavaType getContentType() {
return VALUE_TYPE;
}
@Override
public JsonSerializer getContentSerializer() {
// 14-Jan-2012, tatu: We could refer to an actual serializer if absolutely necessary
return null;
}
@Override
public boolean isEmpty(SerializerProvider prov, long[] value) {
return value.length == 0;
}
@Override
public boolean hasSingleElement(long[] value) {
return (value.length == 1);
}
@Override
public final void serialize(long[] value, JsonGenerator g, SerializerProvider provider) throws IOException
{
final int len = value.length;
if ((len == 1) && _shouldUnwrapSingle(provider)) {
serializeContents(value, g, provider);
return;
}
// 11-May-2016, tatu: As per [core#277] we have efficient `writeArray(...)` available
g.writeArray(value, 0, value.length);
}
@Override
public void serializeContents(long[] value, JsonGenerator g, SerializerProvider provider)
throws IOException
{
for (int i = 0, len = value.length; i < len; ++i) {
g.writeNumber(value[i]);
}
}
@Override
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
{
return createSchemaNode("array", true)
.set("items", createSchemaNode("number", true));
}
@Override
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
throws JsonMappingException
{
visitArrayFormat(visitor, typeHint, JsonFormatTypes.NUMBER);
}
}
@JacksonStdImpl
public static class FloatArraySerializer extends TypedPrimitiveArraySerializer
{
// as above, assuming no one re-defines primitive/wrapper types
@SuppressWarnings("deprecation")
private final static JavaType VALUE_TYPE = TypeFactory.defaultInstance().uncheckedSimpleType(Float.TYPE);
public FloatArraySerializer() {
super(float[].class);
}
public FloatArraySerializer(FloatArraySerializer src, BeanProperty prop,
Boolean unwrapSingle) {
super(src, prop, unwrapSingle);
}
@Override
public JsonSerializer _withResolved(BeanProperty prop,Boolean unwrapSingle) {
return new FloatArraySerializer(this, prop, unwrapSingle);
}
@Override
public JavaType getContentType() {
return VALUE_TYPE;
}
@Override
public JsonSerializer getContentSerializer() {
// 14-Jan-2012, tatu: We could refer to an actual serializer if absolutely necessary
return null;
}
@Override
public boolean isEmpty(SerializerProvider prov, float[] value) {
return value.length == 0;
}
@Override
public boolean hasSingleElement(float[] value) {
return (value.length == 1);
}
@Override
public final void serialize(float[] value, JsonGenerator g, SerializerProvider provider) throws IOException
{
final int len = value.length;
if ((len == 1) && _shouldUnwrapSingle(provider)) {
serializeContents(value, g, provider);
return;
}
g.writeStartArray(value, len);
serializeContents(value, g, provider);
g.writeEndArray();
}
@Override
public void serializeContents(float[] value, JsonGenerator g, SerializerProvider provider)
throws IOException
{
for (int i = 0, len = value.length; i < len; ++i) {
g.writeNumber(value[i]);
}
}
@Override
public JsonNode getSchema(SerializerProvider provider, Type typeHint) {
return createSchemaNode("array", true).set("items", createSchemaNode("number"));
}
@Override
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
{
visitArrayFormat(visitor, typeHint, JsonFormatTypes.NUMBER);
}
}
@JacksonStdImpl
public static class DoubleArraySerializer extends ArraySerializerBase
{
// as above, assuming no one re-defines primitive/wrapper types
@SuppressWarnings("deprecation")
private final static JavaType VALUE_TYPE = TypeFactory.defaultInstance().uncheckedSimpleType(Double.TYPE);
public DoubleArraySerializer() { super(double[].class); }
/**
* @since 2.6
*/
protected DoubleArraySerializer(DoubleArraySerializer src,
BeanProperty prop, Boolean unwrapSingle) {
super(src, prop, unwrapSingle);
}
@Override
public JsonSerializer _withResolved(BeanProperty prop, Boolean unwrapSingle) {
return new DoubleArraySerializer(this, prop, unwrapSingle);
}
/**
* Doubles never add type info; hence, even if type serializer is suggested,
* we'll ignore it...
*/
@Override
public ContainerSerializer _withValueTypeSerializer(TypeSerializer vts) {
return this;
}
@Override
public JavaType getContentType() {
return VALUE_TYPE;
}
@Override
public JsonSerializer getContentSerializer() {
// 14-Jan-2012, tatu: We could refer to an actual serializer if absolutely necessary
return null;
}
@Override
public boolean isEmpty(SerializerProvider prov, double[] value) {
return value.length == 0;
}
@Override
public boolean hasSingleElement(double[] value) {
return (value.length == 1);
}
@Override
public final void serialize(double[] value, JsonGenerator g, SerializerProvider provider) throws IOException
{
final int len = value.length;
if ((len == 1) && _shouldUnwrapSingle(provider)) {
serializeContents(value, g, provider);
return;
}
// 11-May-2016, tatu: As per [core#277] we have efficient `writeArray(...)` available
g.writeArray(value, 0, value.length);
}
@Override
public void serializeContents(double[] value, JsonGenerator g, SerializerProvider provider) throws IOException
{
for (int i = 0, len = value.length; i < len; ++i) {
g.writeNumber(value[i]);
}
}
@Override
public JsonNode getSchema(SerializerProvider provider, Type typeHint) {
return createSchemaNode("array", true).set("items", createSchemaNode("number"));
}
@Override
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
throws JsonMappingException
{
visitArrayFormat(visitor, typeHint, JsonFormatTypes.NUMBER);
}
}
}