Package org.codehaus.jackson.map.ser.std
Class SerializableWithTypeSerializer
java.lang.Object
org.codehaus.jackson.map.JsonSerializer<JsonSerializableWithType>
org.codehaus.jackson.map.ser.std.SerializerBase<JsonSerializableWithType>
org.codehaus.jackson.map.ser.std.SerializableWithTypeSerializer
- All Implemented Interfaces:
SchemaAware
- Direct Known Subclasses:
StdSerializers.SerializableWithTypeSerializer
Generic handler for types that implement
JsonSerializableWithType
.
Note: given that this is used for anything that implements interface, can not be checked for direct class equivalence.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonSerializer
JsonSerializer.None
-
Field Summary
FieldsFields inherited from class org.codehaus.jackson.map.ser.std.SerializerBase
_handledType
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetSchema
(SerializerProvider provider, Type typeHint) Note: since Jackson 1.9, default implementation claims type is "string"void
serialize
(JsonSerializableWithType value, JsonGenerator jgen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.final void
serializeWithType
(JsonSerializableWithType 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 org.codehaus.jackson.map.ser.std.SerializerBase
createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow, wrapAndThrow, wrapAndThrow
Methods inherited from class org.codehaus.jackson.map.JsonSerializer
isUnwrappingSerializer, unwrappingSerializer
-
Field Details
-
instance
-
-
Constructor Details
-
SerializableWithTypeSerializer
protected SerializableWithTypeSerializer()
-
-
Method Details
-
serialize
public void serialize(JsonSerializableWithType 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 classSerializerBase<JsonSerializableWithType>
- 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(JsonSerializableWithType 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 classJsonSerializer<JsonSerializableWithType>
- 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
Description copied from class:SerializerBase
Note: since Jackson 1.9, default implementation claims type is "string"- Specified by:
getSchema
in interfaceSchemaAware
- Overrides:
getSchema
in classSerializerBase<JsonSerializableWithType>
- Parameters:
provider
- The serializer provider.typeHint
- A hint about the type.- Returns:
- Json-schema for this serializer.
- Throws:
JsonMappingException
-