Uses of Annotation Interface
com.fasterxml.jackson.annotation.JacksonAnnotation
Packages that use JacksonAnnotation
Package
Description
Public core annotations, most of which are used to configure how
Data Mapping/Binding works.
Annotations that directly depend on classes in databinding bundle
(not just Jackson core) and cannot be included
in Jackson core annotations package (because it cannot have any
external dependencies).
Classes needed for JSON schema support (currently just ability
to generate schemas using serialization part of data mapping)
Package that contains annotations applicable to all content types.
Package that contains annotations specific to JSON dataformat.
-
Uses of JacksonAnnotation in com.fasterxml.jackson.annotation
Classes in com.fasterxml.jackson.annotation with annotations of type JacksonAnnotationModifier and TypeClassDescription@interfaceMeta-annotation (annotations used on other annotations) used for indicating that instead of using target annotation (annotation annotated with this annotation), Jackson should use meta-annotations it has.@interfaceJackson-specific annotation used for indicating that value of annotated property will be "injected", i.e. set based on value configured byObjectMapper(usually on per-call basis).@interfaceAnnotation that can be used to define one or more alternative names for a property, accepted during deserialization as alternative to the official name.@interfaceMarker annotation that can be used to define a non-static, no-argument method to be an "any getter"; accessor for getting a set of key/value pairs, to be serialized as part of containing POJO (similar to unwrapping) along with regular property values it has.@interfaceMarker annotation that can be used to define a logical "any setter" mutator -- either using non-static two-argument method (first argument name of property, second value to set) or a field (of typeMapor POJO) - to be used as a "fallback" handler for all otherwise unrecognized properties found from JSON content.@interfaceClass annotation that can be used to define which kinds of Methods are to be detected by auto-detection, and with what minimum access level.@interfaceAnnotation used to indicate that associated property is part of two-way linkage between fields; and that its role is "child" (or "back") link.@interfaceAnnotation used to define a human-readable description for annotated type (class).@interfaceMarker annotation that can be used to define constructors and factory methods as one to use for instantiating new instances of the associated class.@interfaceMarker annotation that can be used to define a default value used when trying to deserialize unknown Enum values.@interfaceAnnotation 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, andcom.fasterxml.jackson.databind.ObjectMapper(or objects it delegates to) providing matching filters by id.@interfaceGeneral-purpose annotation used for configuring details of how values of properties are to be serialized.@interfaceMarker annotation that can be used to define a non-static, no-argument value-returning (non-void) method to be used as a "getter" for a logical property.@interfaceAnnotation used for indicating that values of annotated type or property should be serializing so that instances either contain additional object identifier (in addition actual object properties), or as a reference that consists of an object id that refers to a full serialization.@interfaceOptional annotation that can be used for customizing details of a reference to Objects for which "Object Identity" is enabled (seeJsonIdentityInfo).@interfaceMarker annotation that indicates that the logical property that the accessor (field, getter/setter method or Creator parameter [ofJsonCreator-annotated constructor or factory method]) is to be ignored by introspection-based serialization and deserialization functionality.@interfaceAnnotation that can be used to either suppress serialization of properties (during serialization), or ignore processing of JSON properties read (during deserialization).@interfaceMarker annotation that indicates that all properties that have type annotated with this annotation are to be ignored during serialization and deserialization.@interfaceAnnotation used to indicate when value of the annotated property (when used for a field, method or constructor parameter), or all properties of the annotated class, is to be serialized.@interfaceAnnotation that can be used to either only include serialization of properties (during serialization), or only include processing of JSON properties read (during deserialization).@interfaceMarker annotation that indicates that the value of annotated accessor (either field or "getter" method [a method with non-void return type, no args]) is to be used as the single value to serialize for the instance.@interfaceAnnotation used to indicate that annotated property is part of two-way linkage between fields; and that its role is "parent" (or "forward") link.@interfaceAnnotation to specify whether annotated property value should use "merging" approach: merging meaning that the current value is first accessed (with a getter or field) and then modified with incoming data.@interfaceMarker annotation that can be used to define a non-static method as a "setter" or "getter" for a logical property accessor (depending on its signature), or a non-static Object field to be used (serialized, deserialized) as a logical property (to assign value or get value from)@interfaceAnnotation used to define a human-readable description for a logical property.@interfaceAnnotation that can be used to define ordering (possibly partial) to use when serializing object properties.@interfaceMarker annotation that indicates that the annotated method or field should be serialized by including literal String value of the property as is, without quoting of characters.@interfaceAnnotation similar tojavax.xml.bind.annotation.XmlRootElement, used to indicate name to use for root-level wrapping, if wrapping is enabled.@interfaceAnnotation that can be used to define a non-static, single-argument method to be used as a "setter" for a logical property as an alternative to recommendedJsonPropertyannotation; or (as of 2.9 and later), specify additional aspects of the assigning property a value during serialization.@interfaceAnnotation used withJsonTypeInfoto indicate subtypes of serializable polymorphic types, and to associate logical names used within JSON content (which is more portable than using physical Java class names).@interfaceMarker annotation that can be used on a property accessor (field, getter or setter, constructor parameter) to indicate that the property is to contain type id to use when including polymorphic type information.@interfaceAnnotation used for configuring details of if and how type information is used with JSON serialization and deserialization, to preserve information about actual class of Object instances.@interfaceAnnotation used for binding logical name that the annotated class has.@interfaceAnnotation used to indicate that a POJO-valued property should be serialized "unwrapped" -- that is, if it would be serialized as Object value, its properties are instead included as properties of its containing Object -- and deserialized reproducing "missing" structure.@interfaceMarker annotation that indicates that the value of annotated accessor (either field or "getter" method [a method with non-void return type, no args]) is to be used as the single value to serialize for the instance, instead of the usual method of collecting properties of value.@interfaceAnnotation used for indicating view(s) that the property that is defined by method or field annotated is part of. -
Uses of JacksonAnnotation in com.fasterxml.jackson.databind.annotation
Classes in com.fasterxml.jackson.databind.annotation with annotations of type JacksonAnnotationModifier and TypeClassDescription@interfaceAnnotation that can be used to indicate aEnumNamingStrategyto use for annotated class.@interfaceMarker interface used to indicate implementation classes (serializers, deserializers etc) that are standard ones Jackson uses; not custom ones that application has added.@interfaceAnnotation used to add "virtual" properties that will be written after regular properties during serialization.@interfaceAnnotation use for configuring deserialization aspects, by attaching to "setter" methods or fields, or to value classes.@interfaceAnnotation that can be used to indicate aPropertyNamingStrategyto use for annotated class.@interfaceAnnotation used to configure details of a Builder class: instances of which are used as Builders for deserialized POJO values, instead of POJOs being instantiated using constructors or factory methods.@interfaceAnnotation used for configuring serialization aspects, by attaching to "getter" methods or fields, or to value classes.@interfaceAnnotation that can be used to plug a custom type identifier handler (TypeIdResolver) to be used byTypeSerializers andTypeDeserializers for converting between java types and type id included in JSON content.@interfaceAnnotation that can be used to explicitly define custom resolver used for handling serialization and deserialization of type information, needed for handling of polymorphic types (or sometimes just for linking abstract types to concrete types)@interfaceAnnotation that can be used to indicate aValueInstantiatorto use for creating instances of specified type. -
Uses of JacksonAnnotation in com.fasterxml.jackson.databind.jsonschema
Classes in com.fasterxml.jackson.databind.jsonschema with annotations of type JacksonAnnotationModifier and TypeClassDescription@interfaceDeprecated.Since 2.15, we recommend use of external JSON Schema generator module -
Uses of JacksonAnnotation in com.fasterxml.jackson.jakarta.rs.annotation
Classes in com.fasterxml.jackson.jakarta.rs.annotation with annotations of type JacksonAnnotationModifier and TypeClassDescription@interfaceAnnotation that can be used enable and/or disable various features forObjectReaders andObjectWriters. -
Uses of JacksonAnnotation in com.fasterxml.jackson.jakarta.rs.json.annotation
Classes in com.fasterxml.jackson.jakarta.rs.json.annotation with annotations of type JacksonAnnotationModifier and TypeClassDescription@interfaceNote: applicable to annotations to allow bundling (if support added to Jakarta-RS bundle itself), as well as methods to indicate that return type is to be wrapped.