Deprecated
as a consequence of BeanPropertyFilter being deprecated. See corresponding docs for further information.
PropertyFilter implementation that only uses property name
to determine whether to serialize property as is, or to filter it out.
Use of this class as the base implementation for any custom
PropertyFilter implementations is strongly encouraged,
because it can provide default implementation for any methods that may
be added in PropertyFilter (as unfortunate as additions may be).
| Modifier and Type | Class and Description |
|---|---|
| public static class | SimpleBeanPropertyFilter.FilterExceptFilter
Deprecated
as a consequence of Filter implementation which defaults to filtering out unknown
properties and only serializes ones explicitly listed.
SimpleBeanPropertyFilter being deprecated.
|
| public static class | SimpleBeanPropertyFilter.SerializeExceptFilter
Deprecated
as a consequence of Filter implementation which defaults to serializing all
properties, except for ones explicitly listed to be filtered out.
SimpleBeanPropertyFilter being deprecated.
|
| Access | Constructor and Description |
|---|---|
| protected |
| 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)Implements com.
Deprecated
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)Implements com.
Deprecated
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(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)Implements com.
Deprecated
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(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)Implements com. BeanSerializer to let the filter determine whether, and in what
form the given property exist within the parent, or root, schema.
|
| public static SimpleBeanPropertyFilter | filterOutAll()
Deprecated
as a consequence of
Convenience factory method that will return a filter that will
simply filter out everything.
SimpleBeanPropertyFilter being deprecated.
|
| public static SimpleBeanPropertyFilter | filterOutAllExcept(Set<String> properties)
Deprecated
as a consequence of
Factory method to construct filter that filters out all properties except
ones includes in set
SimpleBeanPropertyFilter being deprecated.
|
| public static SimpleBeanPropertyFilter | filterOutAllExcept(String... propertyArray)
Deprecated
as a consequence of
SimpleBeanPropertyFilter being deprecated.
|
| public static PropertyFilter | from(final BeanPropertyFilter src)
Deprecated
as a consequence of
Helper method to ease transition from BeanPropertyFilter being deprecated.
BeanPropertyWriter into
PropertyWriter
|
| protected boolean | include(BeanPropertyWriter writer)
Method called to determine whether property will be included (if 'true' returned) or filtered out (if 'false' returned) |
| protected boolean | include(PropertyWriter writer)
Method called to determine whether property will be included (if 'true' returned) or filtered out (if 'false' returned) |
| protected boolean | includeElement(Object elementValue)
Method that defines what to do with container elements
(values contained in an array or |
| public static SimpleBeanPropertyFilter | serializeAll()
Deprecated
as a consequence of
Convenience factory method that will return a "no-op" filter that will
simply just serialize all properties that are given, and filter out
nothing.
SimpleBeanPropertyFilter being deprecated.
|
| public static SimpleBeanPropertyFilter | serializeAll(Set<String> properties)
Deprecated
Since 2.6; to be removed from 2.7
Factory method that was accidentally added in 2.5 with arguments; basically
works just as an alias of filterOutAllExcept(Set) which is not
very useful.
|
| public static SimpleBeanPropertyFilter | serializeAllExcept(Set<String> properties)
Deprecated
as a consequence of
SimpleBeanPropertyFilter being deprecated.
|
| public static SimpleBeanPropertyFilter | serializeAllExcept(String... propertyArray)
Deprecated
as a consequence of
SimpleBeanPropertyFilter being deprecated.
|
| public void | serializeAsElement(Object
Element value being serializerd elementValue, JsonGenerator Generator use for serializing value jgen, SerializerProvider Provider that can be used for accessing dynamic aspects of serialization
processing provider, PropertyWriter Object called to do actual serialization of the field, if not filtered out writer)Implements com. PropertyWriter, although filters
can choose other to do something different altogether.
|
| public void | serializeAsField(Object
Object that contains property value to serialize bean, JsonGenerator Generator use for serializing value jgen, SerializerProvider Provider that can be used for accessing dynamic aspects of serialization
processing provider, BeanPropertyWriter Default bean property serializer to use writer)Implements com.
Deprecated
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.
|
| 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 provider, PropertyWriter Object called to do actual serialization of the field, if not filtered out writer)Implements com. BeanSerializer to let the 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 PropertyWriter, although filters
can choose other to do something different altogether.
|
| SimpleBeanPropertyFilter | back to summary |
|---|---|
| protected SimpleBeanPropertyFilter() | |
| depositSchemaProperty | back to summary |
|---|---|
| public void depositSchemaProperty(BeanPropertyWriter writer, ObjectNode propertiesNode, SerializerProvider provider) throws JsonMappingException Implements com. Doc from com. Deprecated
Method called by Typical implementation is something like:
if (include(writer)) {
writer.depositSchemaProperty(propertiesNode, provider);
}
| |
| depositSchemaProperty | back to summary |
|---|---|
| public void depositSchemaProperty(BeanPropertyWriter writer, JsonObjectFormatVisitor objectVisitor, SerializerProvider provider) throws JsonMappingException Implements com. Doc from com. Deprecated
Method called by Typical implementation is something like:
if (include(writer)) {
writer.depositSchemaProperty(objectVisitor, provider);
}
| |
| depositSchemaProperty | back to summary |
|---|---|
| public void depositSchemaProperty(PropertyWriter writer, ObjectNode propertiesNode, SerializerProvider provider) throws JsonMappingException Implements com. Doc from com. Deprecated
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 Implements com. Doc from com. Method called by Typical implementation is something like:
if (include(writer)) {
writer.depositSchemaProperty(objectVisitor, provider);
}
| |
| filterOutAll | back to summary |
|---|---|
| public static SimpleBeanPropertyFilter filterOutAll()
Deprecated as a consequence of Convenience factory method that will return a filter that will simply filter out everything.
| |
| filterOutAllExcept | back to summary |
|---|---|
| public static SimpleBeanPropertyFilter filterOutAllExcept(Set<String> properties)
Deprecated as a consequence of Factory method to construct filter that filters out all properties except ones includes in set | |
| filterOutAllExcept | back to summary |
|---|---|
| public static SimpleBeanPropertyFilter filterOutAllExcept(String... propertyArray)
Deprecated as a consequence of | |
| from | back to summary |
|---|---|
| public static PropertyFilter from(final BeanPropertyFilter src)
Deprecated as a consequence of Helper method to ease transition from
| |
| include | back to summary |
|---|---|
| protected boolean include(BeanPropertyWriter writer) Method called to determine whether property will be included (if 'true' returned) or filtered out (if 'false' returned) | |
| include | back to summary |
|---|---|
| protected boolean include(PropertyWriter writer) Method called to determine whether property will be included (if 'true' returned) or filtered out (if 'false' returned)
| |
| includeElement | back to summary |
|---|---|
| protected boolean includeElement(Object elementValue) Method that defines what to do with container elements
(values contained in an array or
| |
| serializeAll | back to summary |
|---|---|
| public static SimpleBeanPropertyFilter serializeAll()
Deprecated as a consequence of Convenience factory method that will return a "no-op" filter that will simply just serialize all properties that are given, and filter out nothing.
| |
| serializeAll | back to summary |
|---|---|
| public static SimpleBeanPropertyFilter serializeAll(Set<String> properties)
Deprecated Since 2.6; to be removed from 2.7 Factory method that was accidentally added in 2.5 with arguments; basically
works just as an alias of
| |
| serializeAllExcept | back to summary |
|---|---|
| public static SimpleBeanPropertyFilter serializeAllExcept(Set<String> properties)
Deprecated as a consequence of | |
| serializeAllExcept | back to summary |
|---|---|
| public static SimpleBeanPropertyFilter serializeAllExcept(String... propertyArray)
Deprecated as a consequence of | |
| serializeAsElement | back to summary |
|---|---|
| public void serializeAsElement(Object elementValue, JsonGenerator jgen, SerializerProvider provider, PropertyWriter writer) throws Exception Implements com. Doc from com. 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 bean, JsonGenerator jgen, SerializerProvider provider, BeanPropertyWriter writer) throws Exception Implements com. Doc from com. Deprecated
Method called by Typical implementation is something like:
if (include(writer)) {
writer.serializeAsField(pojo, jgen, prov);
}
| |
| serializeAsField | back to summary |
|---|---|
| public void serializeAsField(Object pojo, JsonGenerator jgen, SerializerProvider provider, PropertyWriter writer) throws Exception Implements com. Doc from com. Method called by Typical implementation is something like:
if (include(writer)) {
writer.serializeAsField(pojo, gen, prov);
}
| |
Deprecated
as a consequence of SimpleBeanPropertyFilter being deprecated. See corresponding docs for further information.
| Modifier and Type | Field and Description |
|---|---|
| protected final Set | _propertiesToInclude
Set of property names to serialize. |
| pack-priv static final SimpleBeanPropertyFilter. | EXCLUDE_ALL
Deprecated
as a consequence of
SimpleBeanPropertyFilter.FilterExceptFilter being deprecated.
|
| private static final long |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected boolean | include(BeanPropertyWriter writer)
Overrides com. |
| protected boolean | include(PropertyWriter writer)
Overrides com. |
| _propertiesToInclude | back to summary |
|---|---|
| protected final Set<String> _propertiesToInclude Set of property names to serialize. | |
| EXCLUDE_ALL | back to summary |
|---|---|
| pack-priv static final SimpleBeanPropertyFilter. Deprecated as a consequence of | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| FilterExceptFilter | back to summary |
|---|---|
| public FilterExceptFilter(Set<String> properties) | |
| include | back to summary |
|---|---|
| protected boolean include(BeanPropertyWriter writer) Overrides com. Doc from com. Method called to determine whether property will be included (if 'true' returned) or filtered out (if 'false' returned)
| |
| include | back to summary |
|---|---|
| protected boolean include(PropertyWriter writer) Overrides com. Doc from com. Method called to determine whether property will be included (if 'true' returned) or filtered out (if 'false' returned)
| |
Deprecated
as a consequence of SimpleBeanPropertyFilter being deprecated. See corresponding docs for further information.
| Modifier and Type | Field and Description |
|---|---|
| protected final Set | _propertiesToExclude
Set of property names to filter out. |
| pack-priv static final SimpleBeanPropertyFilter. | INCLUDE_ALL
Deprecated
as a consequence of
SimpleBeanPropertyFilter.SerializeExceptFilter being deprecated.
|
| private static final long |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected boolean | include(BeanPropertyWriter writer)
Overrides com. |
| protected boolean | include(PropertyWriter writer)
Overrides com. |
| _propertiesToExclude | back to summary |
|---|---|
| protected final Set<String> _propertiesToExclude Set of property names to filter out. | |
| INCLUDE_ALL | back to summary |
|---|---|
| pack-priv static final SimpleBeanPropertyFilter. Deprecated as a consequence of | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| SerializeExceptFilter | back to summary |
|---|---|
| public SerializeExceptFilter(Set<String> properties) | |
| include | back to summary |
|---|---|
| protected boolean include(BeanPropertyWriter writer) Overrides com. Doc from com. Method called to determine whether property will be included (if 'true' returned) or filtered out (if 'false' returned)
| |
| include | back to summary |
|---|---|
| protected boolean include(PropertyWriter writer) Overrides com. Doc from com. Method called to determine whether property will be included (if 'true' returned) or filtered out (if 'false' returned)
| |