Module tools.jackson.databind

Package tools.jackson.databind.ser

Class FilterProvider

java.lang.Object

tools.jackson.databind.ser.FilterProvider

All Implemented Interfaces:

Snapshottable<FilterProvider>

Direct Known Subclasses:

SimpleFilterProvider

public abstract class FilterProvider
extends Object
implements Snapshottable<FilterProvider>

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 JsonFilter annotation on bean class.

Constructor Summary

Constructors

Constructor	Description
FilterProvider()

Method Summary

Modifier and Type	Method	Description
abstract PropertyFilter	findPropertyFilter(SerializationContext ctxt, Object filterId, Object valueToFilter)	Lookup method used to find PropertyFilter that has specified id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface tools.jackson.core.util.Snapshottable

snapshot

Constructor Details

FilterProvider

public FilterProvider()

Method Details

findPropertyFilter

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 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 - Id of the filter to fetch

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

Returns:

Filter to use, if any.