jackson-databind 2.16.0 · com.fasterxml.jackson.databind.ser.BeanPropertyFilter

Method Summary

Modifier and Type	Method and Description
public void	depositSchemaProperty(BeanPropertyWriter Bean property writer to use to create schema value writer, ObjectNode Node which the given property would exist within propertiesNode, SerializerProvider Provider that can be used for accessing dynamic aspects of serialization processing provider) Deprecated Since 2.3: new code should use the alternative `depositSchemaProperty` method Method called by `BeanSerializer` to let the filter determine whether, and in what form the given property exist within the parent, or root, schema.
public void	depositSchemaProperty(BeanPropertyWriter Bean property serializer to use to create schema value writer, JsonObjectFormatVisitor JsonObjectFormatVisitor which should be aware of the property's existence objectVisitor, SerializerProvider Provider that can be used for accessing dynamic aspects of serialization processing provider) Method called by `BeanSerializer` to let the filter determine whether, and in what form the given property exist within the parent, or root, schema.
public void	serializeAsField(Object Object that contains property value to serialize pojo, JsonGenerator Generator use for serializing value jgen, SerializerProvider Provider that can be used for accessing dynamic aspects of serialization processing prov, BeanPropertyWriter Default bean property serializer to use writer) Method called by `BeanSerializer` to let filter decide what to do with given bean property value: the usual choices are to either filter out (i.e. do nothing) or write using given `BeanPropertyWriter`, although filters can choose other to do something different altogether.

Method Detail

depositSchemaProperty back to summary

depositSchemaProperty	back to summary
public void depositSchemaProperty(BeanPropertyWriter writer, ObjectNode propertiesNode, SerializerProvider provider) throws JsonMappingException Deprecated Since 2.3: new code should use the alternative `depositSchemaProperty` method Method called by `BeanSerializer` to let the filter determine whether, and in what form the given property exist within the parent, or root, schema. Filters can omit adding the property to the node, or choose the form of the schema value for the property. Typical implementation is something like: if (include(writer)) { writer.depositSchemaProperty(propertiesNode, provider); } Parameters writer:BeanPropertyWriter Bean property writer to use to create schema value propertiesNode:ObjectNode Node which the given property would exist within provider:SerializerProvider Provider that can be used for accessing dynamic aspects of serialization processing Annotations @Deprecated Since 2.1

public void depositSchemaProperty(BeanPropertyWriter writer, ObjectNode propertiesNode, SerializerProvider provider) throws JsonMappingException

Deprecated

Since 2.3: new code should use the alternative depositSchemaProperty method

Method called by BeanSerializer to let the filter determine whether, and in what form the given property exist within the parent, or root, schema. Filters can omit adding the property to the node, or choose the form of the schema value for the property.

Typical implementation is something like:

 if (include(writer)) {
      writer.depositSchemaProperty(propertiesNode, provider);
 }

Parameters

writer:BeanPropertyWriter: Bean property writer to use to create schema value
propertiesNode:ObjectNode: Node which the given property would exist within
provider:SerializerProvider: Provider that can be used for accessing dynamic aspects of serialization processing

Annotations

@Deprecated

Since

2.1

depositSchemaProperty back to summary

depositSchemaProperty	back to summary
public void depositSchemaProperty(BeanPropertyWriter writer, JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) throws JsonMappingException Method called by `BeanSerializer` to let the filter determine whether, and in what form the given property exist within the parent, or root, schema. Filters can omit adding the property to the node, or choose the form of the schema value for the property Typical implementation is something like: if (include(writer)) { writer.depositSchemaProperty(objectVisitor, provider); } Parameters writer:BeanPropertyWriter Bean property serializer to use to create schema value objectVisitor:JsonObjectFormatVisitor JsonObjectFormatVisitor which should be aware of the property's existence provider:SerializerProvider Provider that can be used for accessing dynamic aspects of serialization processing Since 2.1

public void depositSchemaProperty(BeanPropertyWriter writer, JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) throws JsonMappingException

Typical implementation is something like:

 if (include(writer)) {
      writer.depositSchemaProperty(objectVisitor, provider);
 }

Parameters

writer:BeanPropertyWriter: Bean property serializer to use to create schema value
objectVisitor:JsonObjectFormatVisitor: JsonObjectFormatVisitor which should be aware of the property's existence
provider:SerializerProvider: Provider that can be used for accessing dynamic aspects of serialization processing

Since

2.1

serializeAsField back to summary

serializeAsField	back to summary
public void serializeAsField(Object pojo, JsonGenerator jgen, SerializerProvider prov, BeanPropertyWriter writer) throws Exception Method called by `BeanSerializer` to let filter decide what to do with given bean property value: the usual choices are to either filter out (i.e. do nothing) or write using given `BeanPropertyWriter`, although filters can choose other to do something different altogether. Typical implementation is something like: if (include(writer)) { writer.serializeAsField(pojo, jgen, prov); } Parameters pojo:Object Object that contains property value to serialize jgen:JsonGenerator Generator use for serializing value prov:SerializerProvider Provider that can be used for accessing dynamic aspects of serialization processing writer:BeanPropertyWriter Default bean property serializer to use

public void serializeAsField(Object pojo, JsonGenerator jgen, SerializerProvider prov, BeanPropertyWriter writer) throws Exception

Method called by BeanSerializer to let filter decide what to do with given bean property value: the usual choices are to either filter out (i.e. do nothing) or write using given BeanPropertyWriter, although filters can choose other to do something different altogether.

Typical implementation is something like:

 if (include(writer)) {
      writer.serializeAsField(pojo, jgen, prov);
 }

Parameters

pojo:Object: Object that contains property value to serialize
jgen:JsonGenerator: Generator use for serializing value
prov:SerializerProvider: Provider that can be used for accessing dynamic aspects of serialization processing
writer:BeanPropertyWriter: Default bean property serializer to use

public Interface BeanPropertyFilter

Method Summary

Method Detail