blob: 2df068e657c5c084a9012a14af5960b22e552c97 [file] [log] [blame]
package org.codehaus.jackson.map.annotate;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.codehaus.jackson.annotate.JacksonAnnotation;
/**
* 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 {@link org.codehaus.jackson.map.ObjectMapper} (or objects
* it delegates to) providing matching filters by id.
* Filters to use are of type
* {@link org.codehaus.jackson.map.ser.BeanPropertyFilter} and
* are registered through {@link org.codehaus.jackson.map.ObjectMapper}
*
* @since 1.7
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonFilter
{
/**
* Id of filter to use; if empty String (""), no filter is to be used.
*/
public String value();
}