Package edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std

Class StaticListSerializerBase<T extends Collection<?>>

java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer<T>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer<T>
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StaticListSerializerBase<T>
All Implemented Interfaces:
JsonFormatVisitable, SchemaAware, ContextualSerializer, Serializable
Direct Known Subclasses:
IndexedStringListSerializer, StringCollectionSerializer
public abstract class StaticListSerializerBase<T extends Collection<?>> extends StdSerializer<T> implements ContextualSerializer
Intermediate base class for Lists, Collections and Arrays that contain static (non-dynamic) value types.
See Also:

  • Field Details

    • _unwrapSingle

      protected final Boolean _unwrapSingle
      Setting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration.
      Since:
      2.6

  • Constructor Details

    • StaticListSerializerBase

      protected StaticListSerializerBase(Class<?> cls)

    • StaticListSerializerBase

      protected StaticListSerializerBase(StaticListSerializerBase<?> src, Boolean unwrapSingle)
      Since:
      2.9

  • Method Details

    • _withResolved

      public abstract JsonSerializer<?> _withResolved(BeanProperty prop, Boolean unwrapSingle)
      Since:
      2.9

    • createContextual

      public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException
      Description copied from interface: ContextualSerializer
      Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. 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.
      Specified by:
      createContextual in interface ContextualSerializer
      Parameters:
      serializers - Serializer provider to use for accessing config, other serializers
      property - 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 cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)
      Returns:
      Serializer to use for serializing values of specified property; may be this instance or a new instance.
      Throws:
      JsonMappingException

    • isEmpty

      public boolean isEmpty(SerializerProvider provider, T 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<T extends Collection<?>>

    • getSchema

      public JsonNode getSchema(SerializerProvider provider, Type typeHint)
      Description copied from class: StdSerializer
      Default implementation simply claims type is "string"; usually overriden by custom serializers.
      Specified by:
      getSchema in interface SchemaAware
      Overrides:
      getSchema in class StdSerializer<T extends Collection<?>>
      Parameters:
      provider - The serializer provider.
      typeHint - A hint about the type.
      Returns:
      Json-schema for this serializer.

    • 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<T extends Collection<?>>
      typeHint - Type of element (entity like property) being visited
      Throws:
      JsonMappingException

    • contentSchema

      protected abstract JsonNode contentSchema()

    • acceptContentVisitor

      protected abstract void acceptContentVisitor(JsonArrayFormatVisitor visitor) throws JsonMappingException
      Throws:
      JsonMappingException

    • serializeWithType

      public abstract void serializeWithType(T value, JsonGenerator g, SerializerProvider provider, 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<T extends Collection<?>>
      Parameters:
      value - Value to serialize; can not be null.
      g - Generator used to output resulting Json content
      provider - 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