public abstract class SimpleBeanPropertyFilter extends Object implements BeanPropertyFilter
BeanPropertyFilter
implementation that only uses property name
to determine whether to serialize property as is, or to filter it out.Modifier and Type | Class and Description |
---|---|
static class |
SimpleBeanPropertyFilter.FilterExceptFilter
Filter implementation which defaults to filtering out unknown
properties and only serializes ones explicitly listed.
|
static class |
SimpleBeanPropertyFilter.SerializeExceptFilter
Filter implementation which defaults to serializing all
properties, except for ones explicitly listed to be filtered out.
|
Modifier | Constructor and Description |
---|---|
protected |
SimpleBeanPropertyFilter() |
Modifier and Type | Method and Description |
---|---|
void |
depositSchemaProperty(BeanPropertyWriter writer,
JsonObjectFormatVisitor objectVisitor,
SerializerProvider 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. |
void |
depositSchemaProperty(BeanPropertyWriter writer,
ObjectNode propertiesNode,
SerializerProvider 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. |
static SimpleBeanPropertyFilter |
filterOutAllExcept(Set<String> properties)
Factory method to construct filter that filters out all properties except
ones includes in set
|
static SimpleBeanPropertyFilter |
filterOutAllExcept(String... propertyArray) |
protected abstract boolean |
include(BeanPropertyWriter writer)
Method called to determine whether property will be included
(if 'true' returned) or filtered out (if 'false' returned)
|
static SimpleBeanPropertyFilter |
serializeAllExcept(Set<String> properties) |
static SimpleBeanPropertyFilter |
serializeAllExcept(String... propertyArray) |
void |
serializeAsField(Object bean,
JsonGenerator jgen,
SerializerProvider provider,
BeanPropertyWriter 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. |
public static SimpleBeanPropertyFilter filterOutAllExcept(Set<String> properties)
public static SimpleBeanPropertyFilter filterOutAllExcept(String... propertyArray)
public static SimpleBeanPropertyFilter serializeAllExcept(Set<String> properties)
public static SimpleBeanPropertyFilter serializeAllExcept(String... propertyArray)
protected abstract boolean include(BeanPropertyWriter writer)
public void serializeAsField(Object bean, JsonGenerator jgen, SerializerProvider provider, BeanPropertyWriter writer) throws Exception
BeanPropertyFilter
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.serializeAsField
in interface BeanPropertyFilter
bean
- Bean of which property value to serializejgen
- Generator use for serializing valueprovider
- Provider that can be used for accessing dynamic aspects of serialization
processingwriter
- Default bean property serializer to useException
public void depositSchemaProperty(BeanPropertyWriter writer, ObjectNode propertiesNode, SerializerProvider provider) throws JsonMappingException
BeanPropertyFilter
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); }
depositSchemaProperty
in interface BeanPropertyFilter
writer
- Bean property serializer to use to create schema valuepropertiesNode
- Node which the given property would exist withinprovider
- Provider that can be used for accessing dynamic aspects of serialization
processingJsonMappingException
public void depositSchemaProperty(BeanPropertyWriter writer, JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) throws JsonMappingException
BeanPropertyFilter
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); }
depositSchemaProperty
in interface BeanPropertyFilter
writer
- Bean property serializer to use to create schema valueobjectVisitor
- JsonObjectFormatVisitor which should be aware of
the property's existenceprovider
- Provider that can be used for accessing dynamic aspects of serialization
processingJsonMappingException
Copyright © 2012-2013 FasterXML. All Rights Reserved.