org.codehaus.jackson.map.ser.std
Class SerializableSerializer
java.lang.Object
org.codehaus.jackson.map.JsonSerializer<T>
org.codehaus.jackson.map.ser.std.SerializerBase<T>
org.codehaus.jackson.map.ser.SerializerBase<JsonSerializable>
org.codehaus.jackson.map.ser.std.SerializableSerializer
- All Implemented Interfaces:
- SchemaAware
- Direct Known Subclasses:
- StdSerializers.SerializableSerializer
public class SerializableSerializer
- extends SerializerBase<JsonSerializable>
Generic handler for types that implement JsonSerializable
.
Note: given that this is used for anything that implements
interface, can not be checked for direct class equivalence.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
instance
public static final SerializableSerializer instance
SerializableSerializer
protected SerializableSerializer()
serialize
public void serialize(JsonSerializable 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<JsonSerializable>
- Parameters:
value
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for
serializing Objects value contains, if any.
- Throws:
IOException
JsonGenerationException
serializeWithType
public final void serializeWithType(JsonSerializable 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, org.codehaus.jackson.JsonGenerator, org.codehaus.jackson.map.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<JsonSerializable>
- Parameters:
value
- Value to serialize; can not be null.jgen
- Generator used to output resulting Json contentprovider
- 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)
throws JsonMappingException
- 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<JsonSerializable>
- Parameters:
provider
- The serializer provider.typeHint
- A hint about the type.
- Returns:
- Json-schema for this serializer.
- Throws:
JsonMappingException