Note
this implementation does not yet properly handle all polymorphic cases
| Modifier and Type | Field and Description |
|---|---|
| protected final JavaType | |
| protected final ObjectArraySerializer | _delegate
We will basically just delegate serialization to the standard Object[] serializer; as we can not sub-class it. |
| Access | Constructor and Description |
|---|---|
| public | |
| protected |
| Modifier and Type | Method and Description |
|---|---|
| protected StdContainerSerializer | _withValueTypeSerializer(TypeSerializer vts)
Overrides tools. Method that needs to be implemented to allow construction of a new
serializer object with given |
| public void | acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
Implements abstract tools. Implements tools. Default implementation specifies no format. |
| public ValueSerializer | createContextual(SerializationContext ctxt, BeanProperty property)
Overrides tools. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). |
| public ValueSerializer | getContentSerializer()
Overrides tools. Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically. |
| public JavaType | getContentType()
Overrides tools. Accessor for finding declared (static) element type for type this serializer is used for. |
| public boolean | hasSingleElement(ObjectContainer<?> value)
Implements abstract tools. Method called to determine if the given value (of type handled by this serializer) contains exactly one element. |
| public boolean | isEmpty(SerializationContext ctxt, ObjectContainer<?> value)
Implements abstract tools. Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values). |
| public void | serialize(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt)
Overrides tools. Method that can be called to ask implementation to serialize values of type this serializer handles. |
| protected void | serializeContents(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt)
Implements abstract tools.
|
| public void | serializeWithType(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer)
Overrides tools. 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 ObjectContainerSerializer |
| _contentType | back to summary |
|---|---|
| protected final JavaType _contentType | |
| _delegate | back to summary |
|---|---|
| protected final ObjectArraySerializer _delegate We will basically just delegate serialization to the standard Object[] serializer; as we can not sub-class it. | |
| ObjectContainerSerializer | back to summary |
|---|---|
| public ObjectContainerSerializer(CollectionLikeType containerType, ObjectArraySerializer delegate) | |
| ObjectContainerSerializer | back to summary |
|---|---|
| protected ObjectContainerSerializer(ObjectContainerSerializer base, ObjectArraySerializer delegate) | |
| _withValueTypeSerializer | back to summary |
|---|---|
| protected StdContainerSerializer Overrides tools. Doc from tools. Method that needs to be implemented to allow construction of a new
serializer object with given
| |
| acceptJsonFormatVisitor | back to summary |
|---|---|
| public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Implements abstract tools. Implements tools. Doc from tools. Default implementation specifies no format. This behavior is usually overriden by custom serializers.
| |
| createContextual | back to summary |
|---|---|
| public ValueSerializer Overrides tools. Doc from tools. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use. Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.
| |
| getContentSerializer | back to summary |
|---|---|
| public ValueSerializer Overrides tools. Doc from tools. Accessor for serializer used for serializing contents
(List and array elements, Map values etc) of the
container for which this serializer is used, if it is
known statically.
Note that for dynamic types this may return null; if so,
caller has to instead use
| |
| getContentType | back to summary |
|---|---|
| public JavaType getContentType() Overrides tools. Doc from tools. Accessor for finding declared (static) element type for type this serializer is used for.
| |
| hasSingleElement | back to summary |
|---|---|
| public boolean hasSingleElement(ObjectContainer<?> value) Implements abstract tools. Doc from tools. Method called to determine if the given value (of type handled by this serializer) contains exactly one element. Note although it might seem sensible to instead define something like "getElementCount()" method, this would not work well for containers that do not keep track of size (like linked lists may not).
Note, too, that this method is only called by serializer
itself; and specifically is not used for non-array/collection types
like
| |
| isEmpty | back to summary |
|---|---|
| public boolean isEmpty(SerializationContext ctxt, ObjectContainer<?> value) Implements abstract tools. Doc from tools. Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values). Default implementation will consider only null values to be empty.
| |
| serialize | back to summary |
|---|---|
| public void serialize(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException Overrides tools. Doc from tools. Method that can be called to ask implementation to serialize values of type this serializer handles.
| |
| serializeContents | back to summary |
|---|---|
| protected void serializeContents(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException Implements abstract tools.
| |
| serializeWithType | back to summary |
|---|---|
| public void serializeWithType(ObjectContainer<?> value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException Overrides tools. Doc from tools. 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 throw 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, gen); serialize(value, gen, provider); typeSer.writeTypeSuffixForScalar(value, gen);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.
| |
| withDelegate | back to summary |
|---|---|
| protected ObjectContainerSerializer withDelegate(ObjectArraySerializer newDelegate) | |