blob: 32fabf9abd331cf48ce1361c0af47796caa6d9f5 [file] [log] [blame]
package org.codehaus.jackson.map.ser.std;
import java.io.IOException;
import java.lang.reflect.Type;
import org.codehaus.jackson.*;
import org.codehaus.jackson.io.SerializedString;
import org.codehaus.jackson.map.*;
import org.codehaus.jackson.map.annotate.JacksonStdImpl;
import org.codehaus.jackson.map.introspect.BasicBeanDescription;
import org.codehaus.jackson.map.util.EnumValues;
import org.codehaus.jackson.node.ObjectNode;
import org.codehaus.jackson.node.ArrayNode;
import org.codehaus.jackson.type.JavaType;
/**
* Standard serializer used for {@link java.lang.Enum} types.
*<p>
* Based on {@link ScalarSerializerBase} since the JSON value is
* scalar (String).
*
* @author tatu
*/
@JacksonStdImpl
public class EnumSerializer
extends ScalarSerializerBase<Enum<?>>
{
/**
* This map contains pre-resolved values (since there are ways
* to customize actual String constants to use) to use as
* serializations.
*/
protected final EnumValues _values;
public EnumSerializer(EnumValues v) {
super(Enum.class, false);
_values = v;
}
public static EnumSerializer construct(Class<Enum<?>> enumClass, SerializationConfig config,
BasicBeanDescription beanDesc)
{
// [JACKSON-212]: If toString() is to be used instead, leave EnumValues null
AnnotationIntrospector intr = config.getAnnotationIntrospector();
EnumValues v = config.isEnabled(SerializationConfig.Feature.WRITE_ENUMS_USING_TO_STRING)
? EnumValues.constructFromToString(enumClass, intr) : EnumValues.constructFromName(enumClass, intr);
return new EnumSerializer(v);
}
@Override
public final void serialize(Enum<?> en, JsonGenerator jgen, SerializerProvider provider)
throws IOException, JsonGenerationException
{
// [JACKSON-684]: serialize as index?
if (provider.isEnabled(SerializationConfig.Feature.WRITE_ENUMS_USING_INDEX)) {
jgen.writeNumber(en.ordinal());
return;
}
jgen.writeString(_values.serializedValueFor(en));
}
@Override
public JsonNode getSchema(SerializerProvider provider, Type typeHint)
{
// [JACKSON-684]: serialize as index?
if (provider.isEnabled(SerializationConfig.Feature.WRITE_ENUMS_USING_INDEX)) {
return createSchemaNode("integer", true);
}
ObjectNode objectNode = createSchemaNode("string", true);
if (typeHint != null) {
JavaType type = provider.constructType(typeHint);
if (type.isEnumType()) {
ArrayNode enumNode = objectNode.putArray("enum");
for (SerializedString value : _values.values()) {
enumNode.add(value.getValue());
}
}
}
return objectNode;
}
public EnumValues getEnumValues() { return _values; }
}