All Implemented Interfaces:
JsonFormatVisitable, SchemaAware, Serializable

public class SerializableSerializer extends StdSerializer<JsonSerializable>
Generic handler for types that implement JsonSerializable.

Note: given that this is used for anything that implements interface, cannot be checked for direct class equivalence.

See Also:
  • Field Details

  • Constructor Details

    • SerializableSerializer

      protected SerializableSerializer()
  • Method Details

    • isEmpty

      public boolean isEmpty(SerializerProvider serializers, JsonSerializable value)
      Description copied from class: JsonSerializer
      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.

      NOTE: replaces JsonSerializer.isEmpty(Object), which was deprecated in 2.5

      Overrides:
      isEmpty in class JsonSerializer<JsonSerializable>
    • serialize

      public void serialize(JsonSerializable value, JsonGenerator gen, SerializerProvider serializers) throws IOException
      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 StdSerializer<JsonSerializable>
      Parameters:
      value - Value to serialize; can not be null.
      gen - Generator used to output resulting Json content
      serializers - Provider that can be used to get serializers for serializing Objects value contains, if any.
      Throws:
      IOException
    • serializeWithType

      public final void serializeWithType(JsonSerializable value, JsonGenerator gen, SerializerProvider serializers, TypeSerializer typeSer) throws IOException
      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 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, 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.
      Overrides:
      serializeWithType in class JsonSerializer<JsonSerializable>
      Parameters:
      value - Value to serialize; can not be null.
      gen - Generator used to output resulting Json content
      serializers - 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
    • acceptJsonFormatVisitor

      public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException
      Description copied from class: StdSerializer
      Default implementation specifies no format. This behavior is usually overriden by custom serializers.
      Specified by:
      acceptJsonFormatVisitor in interface JsonFormatVisitable
      Overrides:
      acceptJsonFormatVisitor in class StdSerializer<JsonSerializable>
      typeHint - Type of element (entity like property) being visited
      Throws:
      JsonMappingException