com.fasterxml.jackson.annotation.JsonFilter )
for filtering bean properties to serialize.
Note that this is the replacement for BeanPropertyFilter,
which is replaced because it was too closely bound to Bean properties
and would not work with java.s or "any getters".
Note that since this is an interface, it is
strongly recommended that custom implementations extend
com.,
to avoid backwards compatibility issues in case interface needs to change.
| Modifier and Type | Method and Description |
|---|---|
| public void | depositSchemaProperty(PropertyWriter
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 |
| public void | depositSchemaProperty(PropertyWriter
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 |
| public void | serializeAsElement(Object
Element value being serializerd elementValue, JsonGenerator Generator use for serializing value gen, SerializerProvider Provider that can be used for accessing dynamic aspects of serialization
processing prov, PropertyWriter Object called to do actual serialization of the field, if not filtered out writer)Method called by container to let the filter decide what to do with given element
value:
the usual choices are to either filter out (i.e.
do nothing) or write using given |
| public void | serializeAsField(Object
Object that contains property value to serialize pojo, JsonGenerator Generator use for serializing value gen, SerializerProvider Provider that can be used for accessing dynamic aspects of serialization
processing prov, PropertyWriter Object called to do actual serialization of the field, if not filtered out writer)Method called by |
| depositSchemaProperty | back to summary |
|---|---|
| public void depositSchemaProperty(PropertyWriter writer, ObjectNode propertiesNode, SerializerProvider provider) throws JsonMappingException
Deprecated Since 2.3: new code should use the alternative Method called by Typical implementation is something like:
if (include(writer)) {
writer.depositSchemaProperty(propertiesNode, provider);
}
| |
| depositSchemaProperty | back to summary |
|---|---|
| public void depositSchemaProperty(PropertyWriter writer, JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) throws JsonMappingException Method called by Typical implementation is something like:
if (include(writer)) {
writer.depositSchemaProperty(objectVisitor, provider);
}
| |
| serializeAsElement | back to summary |
|---|---|
| public void serializeAsElement(Object elementValue, JsonGenerator gen, SerializerProvider prov, PropertyWriter writer) throws Exception Method called by container to let the filter decide what to do with given element
value:
the usual choices are to either filter out (i.e.
do nothing) or write using given Typical implementation is something like:
if (include(writer)) {
writer.serializeAsElement(pojo, gen, prov);
}
| |
| serializeAsField | back to summary |
|---|---|
| public void serializeAsField(Object pojo, JsonGenerator gen, SerializerProvider prov, PropertyWriter writer) throws Exception Method called by Typical implementation is something like:
if (include(writer)) {
writer.serializeAsField(pojo, gen, prov);
}
| |