com.fasterxml.jackson.databind.ser.std

Class BeanSerializerBase

    • Field Detail

      • NAME_FOR_OBJECT_REF

        protected static final PropertyName NAME_FOR_OBJECT_REF

      • _beanType

        protected final JavaType _beanType
        Since:
        2.9

      • _props

        protected final BeanPropertyWriter[] _props
        Writers used for outputting actual property values

      • _filteredProps

        protected final BeanPropertyWriter[] _filteredProps
        Optional filters used to suppress output of properties that are only to be included in certain views

      • _anyGetterWriter

        protected final AnyGetterWriter _anyGetterWriter
        Handler for JsonAnyGetter annotated properties

      • _propertyFilterId

        protected final Object _propertyFilterId
        Id of the bean property filter to use, if any; null if none.

      • _typeId

        protected final AnnotatedMember _typeId
        If using custom type ids (usually via getter, or field), this is the reference to that member.

      • _objectIdWriter

        protected final ObjectIdWriter _objectIdWriter
        If this POJO can be alternatively serialized using just an object id to denote a reference to previously serialized object, this Object will handle details.

      • _serializationShape

        protected final com.fasterxml.jackson.annotation.JsonFormat.Shape _serializationShape
        Requested shape from bean class annotations.

    • Method Detail

      • withIgnorals

        @Deprecated
protected BeanSerializerBase withIgnorals(Set<String> toIgnore)
        Deprecated. Since 2.12
        Mutant factory used for creating a new instance with additional set of properties to ignore (from properties this instance otherwise has)
        Since:
        2.8

      • withByNameInclusion

        protected abstract BeanSerializerBase withByNameInclusion(Set<String> toIgnore,
                                                          Set<String> toInclude)
        Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)
        Since:
        2.12

      • withIgnorals

        @Deprecated
protected BeanSerializerBase withIgnorals(String[] toIgnore)
        Deprecated. since 2.8
        Mutant factory used for creating a new instance with additional set of properties to ignore (from properties this instance otherwise has)

      • asArraySerializer

        protected abstract BeanSerializerBase asArraySerializer()
        Mutant factory for creating a variant that output POJO as a JSON Array. Implementations may ignore this request if output as array is not possible (either at all, or reliably).
        Since:
        2.1

      • withProperties

        protected abstract BeanSerializerBase withProperties(BeanPropertyWriter[] properties,
                                                     BeanPropertyWriter[] filteredProperties)
        Mutant factory used for creating a new instance with modified set of properties.

        Note: in 2.11.x, need to keep non-abstract for slightly better compatibility (XML module extends)

        Since:
        2.11.1

      • createContextual

        public JsonSerializer<?> createContextual(SerializerProvider provider,
                                          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:
        provider - 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

      • usesObjectId

        public boolean usesObjectId()
        Description copied from class: JsonSerializer
        Method that can be called to see whether this serializer instance will use Object Id to handle cyclic references.
        Overrides:
        usesObjectId in class JsonSerializer<Object>

      • serialize

        public abstract void serialize(Object bean,
                               com.fasterxml.jackson.core.JsonGenerator gen,
                               SerializerProvider provider)
                        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<Object>
        Parameters:
        bean - Value to serialize; can not be null.
        gen - Generator used to output resulting Json content
        provider - Provider that can be used to get serializers for serializing Objects value contains, if any.
        Throws:
        IOException

      • serializeWithType

        public void serializeWithType(Object bean,
                              com.fasterxml.jackson.core.JsonGenerator gen,
                              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<Object>
        Parameters:
        bean - Value to serialize; can not be null.
        gen - 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

      • _typeIdDef

        protected final com.fasterxml.jackson.core.type.WritableTypeId _typeIdDef(TypeSerializer typeSer,
                                                                          Object bean,
                                                                          com.fasterxml.jackson.core.JsonToken valueShape)
        Since:
        2.9

      • serializeFieldsFiltered

        protected void serializeFieldsFiltered(Object bean,
                                       com.fasterxml.jackson.core.JsonGenerator gen,
                                       SerializerProvider provider)
                                throws IOException
        Alternative serialization method that gets called when there is a PropertyFilter that needs to be called to determine which properties are to be serialized (and possibly how)
        Throws:
        IOException

Copyright © 2008–2023 FasterXML. All rights reserved.