Package com.fasterxml.jackson.databind.ext

Class CoreXMLSerializers.QNameSerializer

java.lang.Object
com.fasterxml.jackson.databind.JsonSerializer<QName>
com.fasterxml.jackson.databind.ser.std.StdSerializer<QName>
com.fasterxml.jackson.databind.ext.CoreXMLSerializers.QNameSerializer
All Implemented Interfaces:
JsonFormatVisitable, SchemaAware, ContextualSerializer, Serializable
Enclosing class:
CoreXMLSerializers
public static class CoreXMLSerializers.QNameSerializer extends StdSerializer<QName> implements ContextualSerializer
Since:
2.19
See Also:

  • Field Details

  • Constructor Details

    • QNameSerializer

      public QNameSerializer()

  • Method Details

    • 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

    • serialize

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

    • serializeWithType

      public final void serializeWithType(QName value, JsonGenerator g, SerializerProvider ctxt, 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<QName>
      Parameters:
      value - Value to serialize; can not be null.
      g - Generator used to output resulting Json content
      ctxt - 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<QName>
      Parameters:
      typeHint - Type of element (entity like property) being visited
      Throws:
      JsonMappingException