Jackson 3.0.1 · tools.jackson.databind.ser.std.SimpleFilterProvider

Modifier and Type	Field and Description
protected boolean	_cfgFailOnUnknownId Flag that indicates whether request for an unknown filter id should result an exception (default) or not.
protected PropertyFilter	_defaultFilter This is the filter we return in case no mapping was found for given id; default is 'null' (in which case caller typically reports an error), but can be set to an explicit filter.
protected final Map<String, PropertyFilter>	_filtersById Mappings from ids to filters.
private static final long	serialVersionUID

Access	Constructor and Description
public	SimpleFilterProvider()
public	SimpleFilterProvider(Map<String, PropertyFilter> Mapping from id to filter; used as is if if possible mapping)
protected	SimpleFilterProvider(SimpleFilterProvider src)

Method Summary

Modifier and Type	Method and Description
public SimpleFilterProvider	Returns: This provider instance, for call-chaining addFilter(String The id to associate the filter with. id, PropertyFilter The filter to add; filter) Adds an instance of `PropertyFilter` associated with the given `id` parameter.
public SimpleFilterProvider	Returns: This provider instance, for call-chaining addFilter(String The id to associate the filter with. id, SimpleBeanPropertyFilter The filter to add; filter) Overloaded variant just to resolve "ties" when using `SimpleBeanPropertyFilter`.
public PropertyFilter	findPropertyFilter(SerializationContext ctxt, Object filterId, Object valueToFilter) Implements abstract tools.jackson.databind.ser.FilterProvider.findPropertyFilter. 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.
public PropertyFilter	getDefaultFilter()
public PropertyFilter	removeFilter(String id)
public SimpleFilterProvider	setDefaultFilter(PropertyFilter f)
public SimpleFilterProvider	setDefaultFilter(SimpleBeanPropertyFilter f) Overloaded variant just to resolve "ties" when using `SimpleBeanPropertyFilter`.
public SimpleFilterProvider	setFailOnUnknownId(boolean state)
public SimpleFilterProvider	snapshot() Implements tools.jackson.core.util.Snapshottable.snapshot. Method to call to get an instance that may not be modified through any other object, including `this`.
public boolean	willFailOnUnknownId()

_cfgFailOnUnknownId	back to summary
protected boolean _cfgFailOnUnknownId Flag that indicates whether request for an unknown filter id should result an exception (default) or not. Note that this is only relevant if no default filter has been configured.

_defaultFilter	back to summary
protected PropertyFilter _defaultFilter This is the filter we return in case no mapping was found for given id; default is 'null' (in which case caller typically reports an error), but can be set to an explicit filter.

_filtersById	back to summary
protected final Map<String, PropertyFilter> _filtersById Mappings from ids to filters.

serialVersionUID	back to summary
private static final long serialVersionUID

SimpleFilterProvider	back to summary
public SimpleFilterProvider()

SimpleFilterProvider	back to summary
public SimpleFilterProvider(Map<String, PropertyFilter> mapping) Parameters mapping:Map<String, PropertyFilter> Mapping from id to filter; used as is if if possible

SimpleFilterProvider	back to summary
protected SimpleFilterProvider(SimpleFilterProvider src)

Method Detail

addFilter back to summary

addFilter	back to summary
public SimpleFilterProvider addFilter(String id, PropertyFilter filter) Adds an instance of `PropertyFilter` associated with the given `id` parameter. Note that there can always only be one filter associated with a single `id` parameter, meaning a new filter with the same `id` will always override the previously added filter. Warning Binding `id` or `filter` with `null` value will not be validated within this method, but during serialization of target class annotated with `com.fasterxml.jackson.annotation.JsonFilter`. Parameters id:String The id to associate the filter with. filter:PropertyFilter The filter to add; Returns:SimpleFilterProvider This provider instance, for call-chaining

public SimpleFilterProvider addFilter(String id, PropertyFilter filter)

Adds an instance of PropertyFilter associated with the given id parameter. Note that there can always only be one filter associated with a single id parameter, meaning a new filter with the same id will always override the previously added filter.

Warning

Binding id or filter with null value will not be validated within this method, but during serialization of target class annotated with com.fasterxml.jackson.annotation.JsonFilter.

Parameters

id:String: The id to associate the filter with.
filter:PropertyFilter: The filter to add;

Returns:SimpleFilterProvider

This provider instance, for call-chaining

addFilter back to summary

addFilter	back to summary
public SimpleFilterProvider addFilter(String id, SimpleBeanPropertyFilter filter) Overloaded variant just to resolve "ties" when using `SimpleBeanPropertyFilter`. Adds an instance of `SimpleBeanPropertyFilter` associated with the given `id` parameter. Note that there can always only be one filter associated with a single `id` parameter, meaning a new filter with the same `id` will always override the previously added filter. Warning Binding `id` or `filter` with `null` value will not be validated within this method, but during serialization of target class annotated with `com.fasterxml.jackson.annotation.JsonFilter`. Parameters id:String The id to associate the filter with. filter:SimpleBeanPropertyFilter The filter to add; Returns:SimpleFilterProvider This provider instance, for call-chaining

public SimpleFilterProvider addFilter(String id, SimpleBeanPropertyFilter filter)

Overloaded variant just to resolve "ties" when using SimpleBeanPropertyFilter.

Adds an instance of SimpleBeanPropertyFilter associated with the given id parameter. Note that there can always only be one filter associated with a single id parameter, meaning a new filter with the same id will always override the previously added filter.

Warning

Binding id or filter with null value will not be validated within this method, but during serialization of target class annotated with com.fasterxml.jackson.annotation.JsonFilter.

Parameters

id:String: The id to associate the filter with.
filter:SimpleBeanPropertyFilter: The filter to add;

Returns:SimpleFilterProvider

This provider instance, for call-chaining

findPropertyFilter back to summary

findPropertyFilter	back to summary
public PropertyFilter findPropertyFilter(SerializationContext ctxt, Object filterId, Object valueToFilter) Implements abstract tools.jackson.databind.ser.FilterProvider.findPropertyFilter. Doc from tools.jackson.databind.ser.FilterProvider.findPropertyFilter. 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. Annotations @Override

public PropertyFilter findPropertyFilter(SerializationContext ctxt, Object filterId, Object valueToFilter)

Implements abstract tools.jackson.databind.ser.FilterProvider.findPropertyFilter.

Doc from tools.jackson.databind.ser.FilterProvider.findPropertyFilter.

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.

Annotations

@Override

getDefaultFilter	back to summary
public PropertyFilter getDefaultFilter()

removeFilter	back to summary
public PropertyFilter removeFilter(String id)

setDefaultFilter	back to summary
public SimpleFilterProvider setDefaultFilter(PropertyFilter f)

setDefaultFilter	back to summary
public SimpleFilterProvider setDefaultFilter(SimpleBeanPropertyFilter f) Overloaded variant just to resolve "ties" when using `SimpleBeanPropertyFilter`.

setFailOnUnknownId	back to summary
public SimpleFilterProvider setFailOnUnknownId(boolean state)

snapshot	back to summary
public SimpleFilterProvider snapshot() Implements tools.jackson.core.util.Snapshottable.snapshot. Doc from tools.jackson.core.util.Snapshottable.snapshot. Method to call to get an instance that may not be modified through any other object, including `this`. That instance may be `this` if (and only if) this instance is effectively immutable (unmodifiable) through its API: if this is not the case, a new copy with same configuration must be created and returned. Annotations @Override

snapshot

back to summary

public SimpleFilterProvider snapshot()

Implements tools.jackson.core.util.Snapshottable.snapshot.

Doc from tools.jackson.core.util.Snapshottable.snapshot.

Method to call to get an instance that may not be modified through any other object, including `this`. That instance may be `this` if (and only if) this instance is effectively immutable (unmodifiable) through its API: if this is not the case, a new copy with same configuration must be created and returned.

Annotations

@Override

willFailOnUnknownId	back to summary
public boolean willFailOnUnknownId()

public Class SimpleFilterProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail