Top Description Constructors Methods
tools.jackson.databind.ser

public abstract Class FilterProvider

extends Object
implements Snapshottable<FilterProvider>
Class Inheritance
All Implemented Interfaces
tools.jackson.core.util.Snapshottable
Known Direct Subclasses
tools.jackson.databind.ser.std.SimpleFilterProvider
Imports
tools.jackson.core.util.Snapshottable, tools.jackson.databind.SerializationContext
Interface for objects that provides 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 PropertyFilter

Returns:

Filter to use, if any.
findPropertyFilter(SerializationContext ctxt, 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

findPropertyFilterback to summary
public abstract PropertyFilter findPropertyFilter(SerializationContext ctxt, 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.

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.