|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.fasterxml.jackson.databind.JsonSerializer<T>
com.fasterxml.jackson.databind.ser.std.StdSerializer<Object>
com.fasterxml.jackson.databind.ser.std.StdDelegatingSerializer
public class StdDelegatingSerializer
Serializer implementation where given Java type is first converted
to an intermediate "delegate type" (using a configured
Converter, and then this delegate value is serialized by Jackson.
Note that although types may be related, they must not be same; trying to do this will result in an exception.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer |
|---|
JsonSerializer.None |
| Field Summary | |
|---|---|
protected Converter<Object,?> |
_converter
|
protected JsonSerializer<Object> |
_delegateSerializer
Underlying serializer for type T<.code>. |
protected JavaType |
_delegateType
Fully resolved delegate type, with generic information if any available. |
| Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer |
|---|
_handledType |
| Constructor Summary | |
|---|---|
|
StdDelegatingSerializer(Class<T> cls,
Converter<T,?> converter)
|
|
StdDelegatingSerializer(Converter<?,?> converter)
|
protected |
StdDelegatingSerializer(Converter<Object,?> converter,
JavaType delegateType,
JsonSerializer<?> delegateSerializer)
|
| Method Summary | |
|---|---|
void |
acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
Default implementation specifies no format. |
protected Object |
convertValue(Object value)
Method called to convert from source Java value into delegate value (which will be serialized using standard Jackson serializer for delegate type) |
JsonSerializer<?> |
createContextual(SerializerProvider provider,
BeanProperty property)
Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. |
protected Converter<Object,?> |
getConverter()
|
JsonSerializer<?> |
getDelegatee()
Accessor that can be used to determine if this serializer uses another serializer for actual serialization, by delegating calls. |
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint)
Default implementation simply claims type is "string"; usually overriden by custom serializers. |
JsonNode |
getSchema(SerializerProvider provider,
Type typeHint,
boolean isOptional)
Default implementation simply claims type is "string"; usually overriden by custom serializers. |
boolean |
isEmpty(Object value)
Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values). |
void |
serialize(Object value,
JsonGenerator jgen,
SerializerProvider provider)
Method that can be called to ask implementation to serialize values of type this serializer handles. |
void |
serializeWithType(Object 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. |
protected StdDelegatingSerializer |
withDelegate(Converter<Object,?> converter,
JavaType delegateType,
JsonSerializer<?> delegateSerializer)
Method used for creating resolved contextual instances. |
| Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer |
|---|
createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow |
| Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer |
|---|
isUnwrappingSerializer, replaceDelegatee, unwrappingSerializer, usesObjectId |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected final Converter<Object,?> _converter
protected final JavaType _delegateType
protected final JsonSerializer<Object> _delegateSerializer
T<.code>.
| Constructor Detail |
|---|
public StdDelegatingSerializer(Converter<?,?> converter)
public StdDelegatingSerializer(Class<T> cls,
Converter<T,?> converter)
protected StdDelegatingSerializer(Converter<Object,?> converter,
JavaType delegateType,
JsonSerializer<?> delegateSerializer)
| Method Detail |
|---|
protected StdDelegatingSerializer withDelegate(Converter<Object,?> converter,
JavaType delegateType,
JsonSerializer<?> delegateSerializer)
public JsonSerializer<?> createContextual(SerializerProvider provider,
BeanProperty property)
throws JsonMappingException
ContextualSerializer
createContextual in interface ContextualSerializerprovider - Serializer provider to use for accessing config, other serializersproperty - Method or field that represents the property
(and is used to access value to serialize).
Should be available; but there may be cases where caller can not provide it and
null is passed instead (in which case impls usually pass 'this' serializer as is)
JsonMappingExceptionprotected Converter<Object,?> getConverter()
public JsonSerializer<?> getDelegatee()
JsonSerializer
getDelegatee in class JsonSerializer<Object>
public void serialize(Object value,
JsonGenerator jgen,
SerializerProvider provider)
throws IOException,
JsonProcessingException
JsonSerializer
serialize in class StdSerializer<Object>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.
IOException
JsonProcessingException
public void serializeWithType(Object value,
JsonGenerator jgen,
SerializerProvider provider,
TypeSerializer typeSer)
throws IOException,
JsonProcessingException
JsonSerializer
Default implementation will throw UnsupportedOperationException
to indicate that proper type handling needs to be implemented.
For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look 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);and implementations for type serialized as JSON Arrays or Objects would differ slightly, as
START-ARRAY>/END-ARRAY and
START-OBJECT>/END-OBJECT pairs
need to be properly handled with respect to serializing of contents.
- Overrides:
serializeWithType in class JsonSerializer<Object>
- 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
JsonProcessingException
public boolean isEmpty(Object value)
JsonSerializerDefault implementation will consider only null values to be empty.
isEmpty in class JsonSerializer<Object>
public JsonNode getSchema(SerializerProvider provider,
Type typeHint)
throws JsonMappingException
StdSerializer
getSchema in interface SchemaAwaregetSchema in class StdSerializer<Object>provider - The serializer provider.typeHint - A hint about the type.
JsonMappingException
public JsonNode getSchema(SerializerProvider provider,
Type typeHint,
boolean isOptional)
throws JsonMappingException
StdSerializer
getSchema in interface SchemaAwaregetSchema in class StdSerializer<Object>provider - The serializer provider.typeHint - A hint about the type.isOptional - Is the type optional
JsonMappingException
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
JavaType typeHint)
throws JsonMappingException
StdSerializer
acceptJsonFormatVisitor in interface JsonFormatVisitableacceptJsonFormatVisitor in class StdSerializer<Object>typeHint - Type of element (entity like property) being visited
JsonMappingExceptionprotected Object convertValue(Object value)
The default implementation uses configured Converter to do
conversion.
delegateValue -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||