Top Description Constructors Methods
com.fasterxml.jackson.databind.ser

public abstract Class FilterProvider

extends Object
Class Inheritance
Known Direct Subclasses
com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider
Imports
com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter
Interface for objects that providers instances of PropertyFilter that match given ids. A provider is configured to be used during serialization, to find filter to used based on id specified by com.fasterxml.jackson.annotation.JsonFilter annotation on bean class.

Constructor Summary

AccessConstructor and Description
public
FilterProvider()

Method Summary

Modifier and TypeMethod and Description
public abstract BeanPropertyFilter

Returns:

Filter registered with specified id, if one defined; null if none found.
findFilter(Object filterId)
Deprecated Since 2.3 deprecated because BeanPropertyFilter is deprecated;

Lookup method used to find BeanPropertyFilter that has specified id. Note that id is typically a java.lang.String, but is not necessarily limited to that; that is, while standard components use String, custom implementation can choose other kinds of keys.

public PropertyFilter

Returns:

Filter to use, if any.
findPropertyFilter(Object
Id of the filter to fetch
filterId, Object
Object being filtered (usually POJO, but may be a java.util.Map, or in future a container), if available; not available when generating schemas.
valueToFilter)

Lookup method used to find PropertyFilter that has specified id. Note that id is typically a java.lang.String, but is not necessarily limited to that; that is, while standard components use String, custom implementation can choose other kinds of keys.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

FilterProviderback to summary
public FilterProvider()

Method Detail

findFilterback to summary
public abstract BeanPropertyFilter findFilter(Object filterId)

Deprecated

Since 2.3 deprecated because BeanPropertyFilter is deprecated;

Lookup method used to find BeanPropertyFilter that has specified id. Note that id is typically a java.lang.String, but is not necessarily limited to that; that is, while standard components use String, custom implementation can choose other kinds of keys.

Returns:BeanPropertyFilter

Filter registered with specified id, if one defined; null if none found.

Annotations
@Deprecated
findPropertyFilterback to summary
public PropertyFilter findPropertyFilter(Object filterId, Object valueToFilter)

Lookup method used to find PropertyFilter that has specified id. Note that id is typically a java.lang.String, but is not necessarily limited to that; that is, while standard components use String, custom implementation can choose other kinds of keys.

This method is the replacement for findFilter starting with 2.3.

Note that the default implementation is designed to support short-term backwards compatibility, and will call the deprecated findFilter method, then wrap filter if one found as PropertyFilter. It should be overridden by up-to-date implementations

Parameters
filterId:Object

Id of the filter to fetch

valueToFilter:Object

Object being filtered (usually POJO, but may be a java.util.Map, or in future a container), if available; not available when generating schemas.

Returns:PropertyFilter

Filter to use, if any.

Since
2.3