Jackson 3.0.1 · tools.jackson.databind.ser.bean.UnwrappingBeanSerializer

Modifier and Type	Field and Description
protected final NameTransformer	_nameTransformer Transformer used to add prefix and/or suffix for properties of unwrapped POJO.

Access	Constructor and Description
public	UnwrappingBeanSerializer(BeanSerializerBase src, NameTransformer transformer) Constructor used for creating unwrapping instance of a standard `BeanSerializer`
public	UnwrappingBeanSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter)
public	UnwrappingBeanSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter, Object filterId)
protected	UnwrappingBeanSerializer(UnwrappingBeanSerializer src, Set<String> toIgnore)
protected	UnwrappingBeanSerializer(UnwrappingBeanSerializer src, Set<String> toIgnore, Set<String> toInclude)
protected	UnwrappingBeanSerializer(UnwrappingBeanSerializer src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

Method Summary

Modifier and Type	Method and Description
protected BeanSerializerBase	asArraySerializer() Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.asArraySerializer. JSON Array output cannot be done if unwrapping operation is requested; so implementation will simply return 'this'.
public boolean	isUnwrappingSerializer() Overrides tools.jackson.databind.ValueSerializer.isUnwrappingSerializer. Accessor for checking whether this serializer is an "unwrapping" serializer; this is necessary to know since it may also require caller to suppress writing of the leading property name.
public final void	serialize(Object bean, JsonGenerator gen, SerializationContext provider) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.serialize. Main serialization method that will delegate actual output to configured `BeanPropertyWriter` instances.
public void	serializeWithType(Object bean, JsonGenerator gen, SerializationContext provider, TypeSerializer typeSer) Overrides tools.jackson.databind.ser.bean.BeanSerializerBase.serializeWithType. 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.
public String	toString() Overrides tools.jackson.databind.ser.bean.BeanSerializerBase.toString. Returns a string representation of the object.
public ValueSerializer<Object>	unwrappingSerializer(NameTransformer transformer) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.unwrappingSerializer. Lets force sub-classes to implement this, to avoid accidental missing of handling...
protected BeanSerializerBase	withByNameInclusion(Set<String> toIgnore, Set<String> toInclude) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withByNameInclusion. Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)
public BeanSerializerBase	withFilterId(Object filterId) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withFilterId. Mutant factory used for creating a new instance with different filter id (used with `JsonFilter` annotation)
public BeanSerializerBase	withObjectIdWriter(ObjectIdWriter objectIdWriter) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withObjectIdWriter. Mutant factory used for creating a new instance with different `ObjectIdWriter`.
protected BeanSerializerBase	withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withProperties. Mutant factory used for creating a new instance with modified set of properties

Inherited from tools.jackson.databind.ser.bean.BeanSerializerBase:: _serializeObjectId _serializeProperties _serializePropertiesFiltered _serializePropertiesMaybeView _serializePropertiesNoView _serializeWithObjectId _serializeWithObjectId _typeIdDef acceptJsonFormatVisitor canCreateArraySerializer createContextual findConvertingSerializer getFilterId hasViewProperties properties propertyCount resolve usesObjectId

_nameTransformer	back to summary
protected final NameTransformer _nameTransformer Transformer used to add prefix and/or suffix for properties of unwrapped POJO.

UnwrappingBeanSerializer	back to summary
public UnwrappingBeanSerializer(BeanSerializerBase src, NameTransformer transformer) Constructor used for creating unwrapping instance of a standard `BeanSerializer`

UnwrappingBeanSerializer	back to summary
public UnwrappingBeanSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter)

UnwrappingBeanSerializer	back to summary
public UnwrappingBeanSerializer(UnwrappingBeanSerializer src, ObjectIdWriter objectIdWriter, Object filterId)

UnwrappingBeanSerializer	back to summary
protected UnwrappingBeanSerializer(UnwrappingBeanSerializer src, Set<String> toIgnore)

UnwrappingBeanSerializer	back to summary
protected UnwrappingBeanSerializer(UnwrappingBeanSerializer src, Set<String> toIgnore, Set<String> toInclude)

UnwrappingBeanSerializer	back to summary
protected UnwrappingBeanSerializer(UnwrappingBeanSerializer src, BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

Method Detail

asArraySerializer	back to summary
protected BeanSerializerBase asArraySerializer() Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.asArraySerializer. JSON Array output cannot be done if unwrapping operation is requested; so implementation will simply return 'this'. Annotations @Override

asArraySerializer

back to summary

protected BeanSerializerBase asArraySerializer()

Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.asArraySerializer.

JSON Array output cannot be done if unwrapping operation is requested; so implementation will simply return 'this'.

Annotations

@Override

isUnwrappingSerializer	back to summary
public boolean isUnwrappingSerializer() Overrides tools.jackson.databind.ValueSerializer.isUnwrappingSerializer. Doc from tools.jackson.databind.ValueSerializer.isUnwrappingSerializer. Accessor for checking whether this serializer is an "unwrapping" serializer; this is necessary to know since it may also require caller to suppress writing of the leading property name. Annotations @Override

isUnwrappingSerializer

back to summary

public boolean isUnwrappingSerializer()

Overrides tools.jackson.databind.ValueSerializer.isUnwrappingSerializer.

Doc from tools.jackson.databind.ValueSerializer.isUnwrappingSerializer.

Accessor for checking whether this serializer is an "unwrapping" serializer; this is necessary to know since it may also require caller to suppress writing of the leading property name.

Annotations

@Override

serialize back to summary

serialize	back to summary
public final void serialize(Object bean, JsonGenerator gen, SerializationContext provider) throws JacksonException Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.serialize. Main serialization method that will delegate actual output to configured `BeanPropertyWriter` instances. Annotations @Override

public final void serialize(Object bean, JsonGenerator gen, SerializationContext provider) throws JacksonException

Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.serialize.

Main serialization method that will delegate actual output to configured BeanPropertyWriter instances.

Annotations

@Override

serializeWithType back to summary

serializeWithType	back to summary
public void serializeWithType(Object bean, JsonGenerator gen, SerializationContext provider, TypeSerializer typeSer) throws JacksonException Overrides tools.jackson.databind.ser.bean.BeanSerializerBase.serializeWithType. Doc from tools.jackson.databind.ValueSerializer.serializeWithType. 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. Annotations @Override

public void serializeWithType(Object bean, JsonGenerator gen, SerializationContext provider, TypeSerializer typeSer) throws JacksonException

Overrides tools.jackson.databind.ser.bean.BeanSerializerBase.serializeWithType.

Doc from tools.jackson.databind.ValueSerializer.serializeWithType.

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.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides tools.jackson.databind.ser.bean.BeanSerializerBase.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides tools.jackson.databind.ser.bean.BeanSerializerBase.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

unwrappingSerializer	back to summary
public ValueSerializer<Object> unwrappingSerializer(NameTransformer transformer) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.unwrappingSerializer. Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.unwrappingSerializer. Lets force sub-classes to implement this, to avoid accidental missing of handling... Annotations @Override

unwrappingSerializer

back to summary

public ValueSerializer<Object> unwrappingSerializer(NameTransformer transformer)

Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.unwrappingSerializer.

Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.unwrappingSerializer.

Lets force sub-classes to implement this, to avoid accidental missing of handling...

Annotations

@Override

withByNameInclusion	back to summary
protected BeanSerializerBase withByNameInclusion(Set<String> toIgnore, Set<String> toInclude) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withByNameInclusion. Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.withByNameInclusion. Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has) Annotations @Override

withByNameInclusion

back to summary

protected BeanSerializerBase withByNameInclusion(Set<String> toIgnore, Set<String> toInclude)

Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withByNameInclusion.

Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.withByNameInclusion.

Mutant factory used for creating a new instance with additional set of properties to ignore or include (from properties this instance otherwise has)

Annotations

@Override

withFilterId back to summary

withFilterId	back to summary
public BeanSerializerBase withFilterId(Object filterId) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withFilterId. Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.withFilterId. Mutant factory used for creating a new instance with different filter id (used with `JsonFilter` annotation) Annotations @Override

public BeanSerializerBase withFilterId(Object filterId)

Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withFilterId.

Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.withFilterId.

Mutant factory used for creating a new instance with different filter id (used with JsonFilter annotation)

Annotations

@Override

withObjectIdWriter back to summary

withObjectIdWriter	back to summary
public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withObjectIdWriter. Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.withObjectIdWriter. Mutant factory used for creating a new instance with different `ObjectIdWriter`. Annotations @Override

public BeanSerializerBase withObjectIdWriter(ObjectIdWriter objectIdWriter)

Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withObjectIdWriter.

Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.withObjectIdWriter.

Mutant factory used for creating a new instance with different ObjectIdWriter.

Annotations

@Override

withProperties	back to summary
protected BeanSerializerBase withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties) Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withProperties. Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.withProperties. Mutant factory used for creating a new instance with modified set of properties Annotations @Override

withProperties

back to summary

protected BeanSerializerBase withProperties(BeanPropertyWriter[] properties, BeanPropertyWriter[] filteredProperties)

Implements abstract tools.jackson.databind.ser.bean.BeanSerializerBase.withProperties.

Doc from tools.jackson.databind.ser.bean.BeanSerializerBase.withProperties.

Mutant factory used for creating a new instance with modified set of properties

Annotations

@Override

public Class UnwrappingBeanSerializer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail