Top Description Methods
com.fasterxml.jackson.annotation

public @Interface JsonFilter

extends Annotation
Annotations
@Target:ANNOTATION_TYPE, TYPE, METHOD, FIELD, PARAMETER
@Retention:RUNTIME
@JacksonAnnotation
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target

Annotation used to indicate which logical filter is to be used for filtering out properties of type (class) annotated; association made by this annotation declaring ids of filters, and com.fasterxml.jackson.databind.ObjectMapper (or objects it delegates to) providing matching filters by id.

Filters to use are usually of type com.fasterxml.jackson.databind.ser.PropertyFilter and are registered through com.fasterxml.jackson.databind.ObjectMapper

Since 2.3, this annotation can also be used on properties (fields, methods, constructor parameters).

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

Id of filter to use.
value
()

Id of filter to use; if empty String (""), no filter is to be used.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public String value()

Id of filter to use; if empty String (""), no filter is to be used.

Returns:String

Id of filter to use.