Package org.codehaus.jackson.map.ser
Interface BeanPropertyFilter
- All Known Implementing Classes:
SimpleBeanPropertyFilter
,SimpleBeanPropertyFilter.FilterExceptFilter
,SimpleBeanPropertyFilter.SerializeExceptFilter
public interface BeanPropertyFilter
Interface that defines API for filter objects use (as configured
using
JsonFilter
)
for filtering bean properties to serialize.- Since:
- 1.7
-
Method Summary
Modifier and TypeMethodDescriptionvoid
serializeAsField
(Object bean, JsonGenerator jgen, SerializerProvider prov, BeanPropertyWriter writer) Method called byBeanSerializer
to let filter decide what to do with given bean property value: the usual choices are to either filter out (i.e.
-
Method Details
-
serializeAsField
void serializeAsField(Object bean, JsonGenerator jgen, SerializerProvider prov, BeanPropertyWriter writer) throws Exception Method called byBeanSerializer
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 givenBeanPropertyWriter
, although filters can choose other to do something different altogether.- Parameters:
bean
- Bean of which property value to serializejgen
- Generator use for serializing valueprov
- Provider that can be used for accessing dynamic aspects of serialization processingwriter
- Default bean property serializer to use- Throws:
Exception
-