JaxbAnnotationIntrospector (Red Hat JBoss Enterprise Application Platform 7.1.0.GA public API)

java.lang.Object
- com.fasterxml.jackson.databind.AnnotationIntrospector
- - com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector

All Implemented Interfaces:

Versioned, Serializable
```
public class JaxbAnnotationIntrospector
extends AnnotationIntrospector
implements Versioned
```
Annotation introspector that leverages JAXB annotations where applicable to JSON mapping. As of Jackson 2.0, most JAXB annotations are supported at least to some degree. Ones that are NOT yet supported are:
- XmlAnyAttribute not yet used (as of 1.5) but may be in future (as an alias for @JsonAnySetter?)
- XmlAnyElement not yet used, may be as per [JACKSON-253]
- XmlAttachmentRef: JSON does not support external attachments
- XmlElementDecl
- XmlElementRefs because Jackson doesn't have any support for 'named' collection items -- however, this may become partially supported as per [JACKSON-253].
- XmlInlineBinaryData since the underlying concepts (like XOP) do not exist in JSON -- Jackson will always use inline base64 encoding as the method
- XmlList because JSON does have (or necessarily need) method of serializing list of values as space-separated Strings
- XmlMimeType
- XmlMixed since JSON has no concept of mixed content
- XmlRegistry
- XmlSchema not used, unlikely to be used
- XmlSchemaType not used, unlikely to be used
- XmlSchemaTypes not used, unlikely to be used
- XmlSeeAlso not yet supported, but [ISSUE-1] filed to use it, so may be supported.
Note also the following limitations:
- Any property annotated with XmlValue will have implicit property named 'value' on its JSON object; although (as of 2.4) it should be possible to override this name
A note on compatibility with Jackson XML module: since this module does not depend on Jackson XML module, it is bit difficult to make sure we will properly expose all information. But effort is made (as of version 2.3.3) to expose this information, even without using a specific sub-class from that project.
Author:

Ryan Heaton, Tatu Saloranta

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.AnnotationIntrospector
  AnnotationIntrospector.ReferenceProperty

Field Summary

Fields
Modifier and Type	Field and Description
`protected JsonDeserializer<?>`	`_dataHandlerDeserializer`
`protected JsonSerializer<?>`	`_dataHandlerSerializer`
`protected boolean`	`_ignoreXmlIDREF`
`protected String`	`_jaxbPackageName`
`protected JsonInclude.Include`	`_nonNillableInclusion` Inclusion value to return for properties annotated with `XmlElement` and `XmlElementWrapper`, in case `nillable` property is left as `false.`
`protected TypeFactory`	`_typeFactory`
`protected String`	`_xmlValueName` When using `XmlValue` annotation, a placeholder name is assigned to property (unless overridden by explicit name); this configuration value specified what that name is.
`protected static boolean`	`DEFAULT_IGNORE_XMLIDREF`
`protected static String`	`DEFAULT_NAME_FOR_XML_VALUE`
`protected static JsonFormat.Value`	`FORMAT_INT`
`protected static JsonFormat.Value`	`FORMAT_STRING`
`protected static String`	`MARKER_FOR_DEFAULT`

Constructor Summary

Constructors
Constructor and Description
`JaxbAnnotationIntrospector()` Deprecated. Since 2.1, use constructor that takes TypeFactory.
`JaxbAnnotationIntrospector(MapperConfig<?> config)`
`JaxbAnnotationIntrospector(TypeFactory typeFactory)`
`JaxbAnnotationIntrospector(TypeFactory typeFactory, boolean ignoreXmlIDREF)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected Converter<Object,Object>`	`_converter(XmlAdapter<?,?> adapter, boolean forSerialization)`
`protected Class<?>`	`_doFindDeserializationType(Annotated a, JavaType baseType)`
`protected XmlAdapter<?,?>`	`_findContentAdapter(Annotated ann, boolean forSerialization)`
`protected JavaType`	`_fullDeserializationType(AnnotatedMember am)`
`protected JavaType`	`_fullSerializationType(AnnotatedMember am)`
`protected Class<?>`	`_getTypeFromXmlElement(Annotated a)`
`protected String`	`_propertyNameToString(PropertyName n)`
`protected Class<?>`	`_rawDeserializationType(Annotated a)`
`protected Class<?>`	`_rawSerializationType(Annotated a)`
`protected TypeResolverBuilder<?>`	`_typeResolverFromXmlElements(AnnotatedMember am)`
`protected XmlAccessType`	`findAccessType(Annotated ac)` Method for locating JAXB `XmlAccessType` annotation value for given annotated entity, if it has one, or inherits one from its ancestors (in JAXB sense, package etc).
`VisibilityChecker<?>`	`findAutoDetectVisibility(AnnotatedClass ac, VisibilityChecker<?> checker)` Method for checking if annotations indicate changes to minimum visibility levels needed for auto-detecting property elements (fields, methods, constructors).
`Object`	`findContentDeserializer(Annotated a)` Method for getting a deserializer definition for content (values) of associated `Collection`, `array` or `Map` property.
`Object`	`findContentSerializer(Annotated a)` Method for getting a serializer definition for content (values) of associated `Collection`, `array` or `Map` property.
`Object`	`findDeserializationContentConverter(AnnotatedMember a)` Method for finding `Converter` that annotated property has indicated needs to be used for values of container type (this also means that method should only be called for properties of container types, List/Map/array properties).
`Class<?>`	`findDeserializationContentType(Annotated a, JavaType baseContentType)` Deprecated.
`Object`	`findDeserializationConverter(Annotated a)` Method for finding `Converter` that annotated entity (property or class) has indicated to be used as part of deserialization.
`Class<?>`	`findDeserializationType(Annotated a, JavaType baseType)` Deprecated.
`Object`	`findDeserializer(Annotated am)` Method for getting a deserializer definition on specified method or field.
`String`	`findEnumValue(Enum<?> e)` Deprecated.
`String[]`	`findEnumValues(Class<?> enumType, Enum<?>[] enumValues, String[] names)` Method for efficiently figuring out which if given set of `Enum` values have explicitly defined name.
`JsonFormat.Value`	`findFormat(Annotated m)` Method for finding format annotations for property or class.
`String`	`findImplicitPropertyName(AnnotatedMember m)` Method for finding implicit name for a property that given annotated member (field, method, creator parameter) may represent.
`Object`	`findKeyDeserializer(Annotated am)` Method for getting a deserializer definition for keys of associated `Map` property.
`PropertyName`	`findNameForDeserialization(Annotated a)` Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for deserialization (reading JSON into POJOs).
`PropertyName`	`findNameForSerialization(Annotated a)` Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for serialization.
`String`	`findNamespace(Annotated ann)`
`ObjectIdInfo`	`findObjectIdInfo(Annotated ann)` Method for checking whether given annotated thing (type, or accessor) indicates that values referenced (values of type of annotated class, or values referenced by annotated property; latter having precedence) should include Object Identifier, and if so, specify details of Object Identity used.
`ObjectIdInfo`	`findObjectReferenceInfo(Annotated ann, ObjectIdInfo base)` Method for figuring out additional properties of an Object Identity reference
`TypeResolverBuilder<?>`	`findPropertyContentTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType containerType)` Method for checking if given structured property entity (field or method that has nominal value of Map, Collection or array type) has annotations that indicate that specific type resolver is to be used for handling type information of contained values.
`JsonInclude.Value`	`findPropertyInclusion(Annotated a)` Method for checking inclusion criteria for a type (Class) or property (yes, method name is bit unfortunate -- not just for properties!).
`TypeResolverBuilder<?>`	`findPropertyTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType baseType)` Method for checking if given property entity (field or method) has annotations that indicate that specific type resolver is to be used for handling instances.
`PropertyName`	`findRootName(AnnotatedClass ac)` Method for locating name used as "root name" (for use by some serializers when outputting root-level object -- mostly for XML compatibility purposes) for given class, if one is defined.
`Object`	`findSerializationContentConverter(AnnotatedMember a)` Method for finding `Converter` that annotated property has indicated needs to be used for values of container type (this also means that method should only be called for properties of container types, List/Map/array properties).
`Object`	`findSerializationConverter(Annotated a)` Method for finding `Converter` that annotated entity (property or class) has indicated to be used as part of serialization.
`JsonInclude.Include`	`findSerializationInclusion(Annotated a, JsonInclude.Include defValue)` Deprecated.
`String[]`	`findSerializationPropertyOrder(AnnotatedClass ac)` Method for accessing defined property serialization order (which may be partial).
`Boolean`	`findSerializationSortAlphabetically(Annotated ann)` Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) ordered
`Class<?>`	`findSerializationType(Annotated a)` Deprecated.
`JsonSerializer<?>`	`findSerializer(Annotated am)` Method for getting a serializer definition on specified method or field.
`List<NamedType>`	`findSubtypes(Annotated a)` Method for locating annotation-specified subtypes related to annotated entity (class, method, field).
`String`	`findTypeName(AnnotatedClass ac)` Method for checking if specified type has explicit name.
`TypeResolverBuilder<?>`	`findTypeResolver(MapperConfig<?> config, AnnotatedClass ac, JavaType baseType)` Method for checking if given class has annotations that indicate that specific type resolver is to be used for handling instances.
`PropertyName`	`findWrapperName(Annotated ann)` Method used to check if specified property has annotation that indicates that it should be wrapped in an element; and if so, name to use.
`String`	`getNameUsedForXmlValue()` Accessor for getting currently configured placeholder named used for property annotated with `XmlValue`.
`JsonInclude.Include`	`getNonNillableInclusion()`
`protected TypeFactory`	`getTypeFactory()`
`boolean`	`hasAsValueAnnotation(AnnotatedMethod am)` Method for checking whether given method has an annotation that suggests that the return value of annotated method should be used as "the value" of the object instance; usually serialized as a primitive value such as String or number.
`boolean`	`hasCreatorAnnotation(Annotated am)` Method for checking whether given annotated item (method, constructor) has an annotation that suggests that the method is a "creator" (aka factory) method to be used for construct new instances of deserialized values.
`boolean`	`hasIgnoreMarker(AnnotatedMember m)` Method called to check whether given property is marked to be ignored.
`Boolean`	`hasRequiredMarker(AnnotatedMember m)` Method that can be called to check whether this member has an annotation that suggests whether value for matching property is required or not.
`Boolean`	`isIgnorableType(AnnotatedClass ac)` Method for checking whether properties that have specified type (class, not generics aware) should be completely ignored for serialization and deserialization purposes.
`protected boolean`	`isJAXBAnnotation(Annotation ann)` An annotation is handled if it's in the same package as @XmlElement, including subpackages.
`Boolean`	`isOutputAsAttribute(Annotated ann)` Here we assume fairly simple logic; if there is `XmlAttribute` to be found, we consider it an attribute; if `XmlElement`, not-an-attribute; and otherwise we will consider there to be no information.
`Boolean`	`isOutputAsText(Annotated ann)`
`JavaType`	`refineDeserializationType(MapperConfig<?> config, Annotated a, JavaType baseType)` Method called to find out possible type refinements to use for deserialization.
`JavaType`	`refineSerializationType(MapperConfig<?> config, Annotated a, JavaType baseType)` Method called to find out possible type refinements to use for deserialization.
`void`	`setNameUsedForXmlValue(String name)` Configuration method that can be used to change default name ("value") used for properties annotated with `XmlValue`; note that setting it to `null` will actually avoid name override, and name will instead be derived from underlying method name using standard bean name introspection.
`JaxbAnnotationIntrospector`	`setNonNillableInclusion(JsonInclude.Include incl)` Method to call to change inclusion criteria used for property annotated with `XmlElement` or `XmlElementWrapper`, with `nillable` set as `false`.
`Version`	`version()` Method that will return version information stored in and read from jar that contains this class.

Methods inherited from class com.fasterxml.jackson.databind.AnnotationIntrospector
_findAnnotation, _hasAnnotation, _hasOneOf, allIntrospectors, allIntrospectors, findAndAddVirtualProperties, findClassDescription, findCreatorBinding, findDefaultEnumValue, findDeserializationKeyType, findFilterId, findIgnoreUnknownProperties, findInjectableValueId, findKeySerializer, findNamingStrategy, findNullSerializer, findPOJOBuilder, findPOJOBuilderConfig, findPropertiesToIgnore, findPropertiesToIgnore, findPropertyAccess, findPropertyDefaultValue, findPropertyDescription, findPropertyIgnorals, findPropertyIndex, findReferenceType, findSerializationContentType, findSerializationInclusionForContent, findSerializationKeyType, findSerializationTyping, findUnwrappingNameTransformer, findValueInstantiator, findViews, hasAnyGetterAnnotation, hasAnySetterAnnotation, isAnnotationBundle, isTypeId, nopInstance, pair, resolveSetterConflict

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_NAME_FOR_XML_VALUE
```
protected static final String DEFAULT_NAME_FOR_XML_VALUE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_IGNORE_XMLIDREF
```
protected static final boolean DEFAULT_IGNORE_XMLIDREF
```
    See Also:
    
    Constant Field Values
  - MARKER_FOR_DEFAULT
```
protected static final String MARKER_FOR_DEFAULT
```
    See Also:
    
    Constant Field Values
  - FORMAT_STRING
```
protected static final JsonFormat.Value FORMAT_STRING
```
  - FORMAT_INT
```
protected static final JsonFormat.Value FORMAT_INT
```
  - _jaxbPackageName
```
protected final String _jaxbPackageName
```
  - _dataHandlerSerializer
```
protected final JsonSerializer<?> _dataHandlerSerializer
```
  - _dataHandlerDeserializer
```
protected final JsonDeserializer<?> _dataHandlerDeserializer
```
  - _typeFactory
```
protected final TypeFactory _typeFactory
```
  - _ignoreXmlIDREF
```
protected final boolean _ignoreXmlIDREF
```
  - _xmlValueName
```
protected String _xmlValueName
```
    When using XmlValue annotation, a placeholder name is assigned to property (unless overridden by explicit name); this configuration value specified what that name is.
  - _nonNillableInclusion
```
protected JsonInclude.Include _nonNillableInclusion
```
    Inclusion value to return for properties annotated with XmlElement and XmlElementWrapper, in case nillable property is left as false. Default setting is null; this is typically changed to either JsonInclude.Include.NON_NULL or JsonInclude.Include.NON_EMPTY.
    Since: 2.7
Constructor Detail JaxbAnnotationIntrospector @Deprecated public JaxbAnnotationIntrospector() Deprecated. Since 2.1, use constructor that takes TypeFactory. JaxbAnnotationIntrospector public JaxbAnnotationIntrospector(MapperConfig<?> config) JaxbAnnotationIntrospector public JaxbAnnotationIntrospector(TypeFactory typeFactory) JaxbAnnotationIntrospector public JaxbAnnotationIntrospector(TypeFactory typeFactory, boolean ignoreXmlIDREF) Parameters: typeFactory - Type factory used for resolving type information ignoreXmlIDREF - Whether XmlIDREF annotation should be processed JAXB style (meaning that references are always serialized using id), or not (first reference as full POJO, others as ids) Method Detail version public Version version() Method that will return version information stored in and read from jar that contains this class. Specified by: version in interface Versioned Specified by: version in class AnnotationIntrospector setNameUsedForXmlValue public void setNameUsedForXmlValue(String name) Configuration method that can be used to change default name ("value") used for properties annotated with XmlValue; note that setting it to null will actually avoid name override, and name will instead be derived from underlying method name using standard bean name introspection. Since: 2.5 getNameUsedForXmlValue public String getNameUsedForXmlValue() Accessor for getting currently configured placeholder named used for property annotated with XmlValue. setNonNillableInclusion public JaxbAnnotationIntrospector setNonNillableInclusion(JsonInclude.Include incl) Method to call to change inclusion criteria used for property annotated with XmlElement or XmlElementWrapper, with nillable set as false. Since: 2.7 getNonNillableInclusion public JsonInclude.Include getNonNillableInclusion() Since: 2.7 findNamespace public String findNamespace(Annotated ann) isOutputAsAttribute public Boolean isOutputAsAttribute(Annotated ann) Here we assume fairly simple logic; if there is XmlAttribute to be found, we consider it an attribute; if XmlElement, not-an-attribute; and otherwise we will consider there to be no information. Caller is likely to default to considering things as elements. isOutputAsText public Boolean isOutputAsText(Annotated ann) findObjectIdInfo public ObjectIdInfo findObjectIdInfo(Annotated ann) Description copied from class: AnnotationIntrospector Method for checking whether given annotated thing (type, or accessor) indicates that values referenced (values of type of annotated class, or values referenced by annotated property; latter having precedence) should include Object Identifier, and if so, specify details of Object Identity used. Overrides: findObjectIdInfo in class AnnotationIntrospector findObjectReferenceInfo public ObjectIdInfo findObjectReferenceInfo(Annotated ann, ObjectIdInfo base) Description copied from class: AnnotationIntrospector Method for figuring out additional properties of an Object Identity reference Overrides: findObjectReferenceInfo in class AnnotationIntrospector findRootName public PropertyName findRootName(AnnotatedClass ac) Description copied from class: AnnotationIntrospector Method for locating name used as "root name" (for use by some serializers when outputting root-level object -- mostly for XML compatibility purposes) for given class, if one is defined. Returns null if no declaration found; can return explicit empty String, which is usually ignored as well as null. NOTE: method signature changed in 2.1, to return PropertyName instead of String. Overrides: findRootName in class AnnotationIntrospector isIgnorableType public Boolean isIgnorableType(AnnotatedClass ac) Description copied from class: AnnotationIntrospector Method for checking whether properties that have specified type (class, not generics aware) should be completely ignored for serialization and deserialization purposes. Overrides: isIgnorableType in class AnnotationIntrospector Parameters: ac - Type to check Returns: Boolean.TRUE if properties of type should be ignored; Boolean.FALSE if they are not to be ignored, null for default handling (which is 'do not ignore') hasIgnoreMarker public boolean hasIgnoreMarker(AnnotatedMember m) Description copied from class: AnnotationIntrospector Method called to check whether given property is marked to be ignored. This is used to determine whether to ignore properties, on per-property basis, usually combining annotations from multiple accessors (getters, setters, fields, constructor parameters). Overrides: hasIgnoreMarker in class AnnotationIntrospector hasRequiredMarker public Boolean hasRequiredMarker(AnnotatedMember m) Description copied from class: AnnotationIntrospector Method that can be called to check whether this member has an annotation that suggests whether value for matching property is required or not. Overrides: hasRequiredMarker in class AnnotationIntrospector findWrapperName public PropertyName findWrapperName(Annotated ann) Description copied from class: AnnotationIntrospector Method used to check if specified property has annotation that indicates that it should be wrapped in an element; and if so, name to use. Note that not all serializers and deserializers support use this method: currently (2.1) it is only used by XML-backed handlers. Overrides: findWrapperName in class AnnotationIntrospector Returns: Wrapper name to use, if any, or PropertyName.USE_DEFAULT to indicate that no wrapper element should be used. findImplicitPropertyName public String findImplicitPropertyName(AnnotatedMember m) Description copied from class: AnnotationIntrospector Method for finding implicit name for a property that given annotated member (field, method, creator parameter) may represent. This is different from explicit, annotation-based property name, in that it is "weak" and does not either proof that a property exists (for example, if visibility is not high enough), or override explicit names. In practice this method is used to introspect optional names for creator parameters (which may or may not be available and can not be detected by standard databind); or to provide alternate name mangling for fields, getters and/or setters. Overrides: findImplicitPropertyName in class AnnotationIntrospector findFormat public JsonFormat.Value findFormat(Annotated m) Description copied from class: AnnotationIntrospector Method for finding format annotations for property or class. Return value is typically used by serializers and/or deserializers to customize presentation aspects of the serialized value. Overrides: findFormat in class AnnotationIntrospector findAutoDetectVisibility public VisibilityChecker<?> findAutoDetectVisibility(AnnotatedClass ac, VisibilityChecker<?> checker) Description copied from class: AnnotationIntrospector Method for checking if annotations indicate changes to minimum visibility levels needed for auto-detecting property elements (fields, methods, constructors). A baseline checker is given, and introspector is to either return it as is (if no annotations are found), or build and return a derived instance (using checker's build methods). Overrides: findAutoDetectVisibility in class AnnotationIntrospector findAccessType protected XmlAccessType findAccessType(Annotated ac) Method for locating JAXB XmlAccessType annotation value for given annotated entity, if it has one, or inherits one from its ancestors (in JAXB sense, package etc). Returns null if nothing has been explicitly defined. findTypeResolver public TypeResolverBuilder<?> findTypeResolver(MapperConfig<?> config, AnnotatedClass ac, JavaType baseType) Description copied from class: AnnotationIntrospector Method for checking if given class has annotations that indicate that specific type resolver is to be used for handling instances. This includes not only instantiating resolver builder, but also configuring it based on relevant annotations (not including ones checked with a call to AnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated) Overrides: findTypeResolver in class AnnotationIntrospector Parameters: config - Configuration settings in effect (for serialization or deserialization) ac - Annotated class to check for annotations baseType - Base java type of value for which resolver is to be found Returns: Type resolver builder for given type, if one found; null if none findPropertyTypeResolver public TypeResolverBuilder<?> findPropertyTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType baseType) Description copied from class: AnnotationIntrospector Method for checking if given property entity (field or method) has annotations that indicate that specific type resolver is to be used for handling instances. This includes not only instantiating resolver builder, but also configuring it based on relevant annotations (not including ones checked with a call to AnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated) Overrides: findPropertyTypeResolver in class AnnotationIntrospector Parameters: config - Configuration settings in effect (for serialization or deserialization) am - Annotated member (field or method) to check for annotations baseType - Base java type of property for which resolver is to be found Returns: Type resolver builder for properties of given entity, if one found; null if none findPropertyContentTypeResolver public TypeResolverBuilder<?> findPropertyContentTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType containerType) Description copied from class: AnnotationIntrospector Method for checking if given structured property entity (field or method that has nominal value of Map, Collection or array type) has annotations that indicate that specific type resolver is to be used for handling type information of contained values. This includes not only instantiating resolver builder, but also configuring it based on relevant annotations (not including ones checked with a call to AnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated) Overrides: findPropertyContentTypeResolver in class AnnotationIntrospector Parameters: config - Configuration settings in effect (for serialization or deserialization) am - Annotated member (field or method) to check for annotations containerType - Type of property for which resolver is to be found (must be a container type) Returns: Type resolver builder for values contained in properties of given entity, if one found; null if none _typeResolverFromXmlElements protected TypeResolverBuilder<?> _typeResolverFromXmlElements(AnnotatedMember am) findSubtypes public List<NamedType> findSubtypes(Annotated a) Description copied from class: AnnotationIntrospector Method for locating annotation-specified subtypes related to annotated entity (class, method, field). Note that this is only guaranteed to be a list of directly declared subtypes, no recursive processing is guarantees (i.e. caller has to do it if/as necessary) Overrides: findSubtypes in class AnnotationIntrospector Parameters: a - Annotated entity (class, field/method) to check for annotations findTypeName public String findTypeName(AnnotatedClass ac) Description copied from class: AnnotationIntrospector Method for checking if specified type has explicit name. Overrides: findTypeName in class AnnotationIntrospector Parameters: ac - Class to check for type name annotations findSerializer public JsonSerializer<?> findSerializer(Annotated am) Description copied from class: AnnotationIntrospector Method for getting a serializer definition on specified method or field. Type of definition is either instance (of type JsonSerializer) or Class (of type Class<JsonSerializer>); if value of different type is returned, a runtime exception may be thrown by caller. Overrides: findSerializer in class AnnotationIntrospector findContentSerializer public Object findContentSerializer(Annotated a) Description copied from class: AnnotationIntrospector Method for getting a serializer definition for content (values) of associated Collection, array or Map property. Type of definition is either instance (of type JsonSerializer) or Class (of type Class<JsonSerializer>); if value of different type is returned, a runtime exception may be thrown by caller. Overrides: findContentSerializer in class AnnotationIntrospector findSerializationType @Deprecated public Class<?> findSerializationType(Annotated a) Deprecated. Description copied from class: AnnotationIntrospector Method for accessing annotated type definition that a method/field can have, to be used as the type for serialization instead of the runtime type. Type returned (if any) needs to be widening conversion (super-type). Declared return type of the method is also considered acceptable. Overrides: findSerializationType in class AnnotationIntrospector Returns: Class to use instead of runtime type findSerializationInclusion @Deprecated public JsonInclude.Include findSerializationInclusion(Annotated a, JsonInclude.Include defValue) Deprecated. Implementation of this method is slightly tricky, given that JAXB defaults differ from Jackson defaults. As of version 1.5 and above, this is resolved by honoring Jackson defaults (which are configurable), and only using JAXB explicit annotations. Overrides: findSerializationInclusion in class AnnotationIntrospector Returns: Enumerated value indicating which properties to include in serialization findPropertyInclusion public JsonInclude.Value findPropertyInclusion(Annotated a) Description copied from class: AnnotationIntrospector Method for checking inclusion criteria for a type (Class) or property (yes, method name is bit unfortunate -- not just for properties!). In case of class, acts as the default for properties POJO contains; for properties acts as override for class defaults and possible global defaults. Overrides: findPropertyInclusion in class AnnotationIntrospector refineSerializationType public JavaType refineSerializationType(MapperConfig<?> config, Annotated a, JavaType baseType) throws JsonMappingException Description copied from class: AnnotationIntrospector Method called to find out possible type refinements to use for deserialization. Overrides: refineSerializationType in class AnnotationIntrospector Throws: JsonMappingException findSerializationPropertyOrder public String[] findSerializationPropertyOrder(AnnotatedClass ac) Description copied from class: AnnotationIntrospector Method for accessing defined property serialization order (which may be partial). May return null if no ordering is defined. Overrides: findSerializationPropertyOrder in class AnnotationIntrospector findSerializationSortAlphabetically public Boolean findSerializationSortAlphabetically(Annotated ann) Description copied from class: AnnotationIntrospector Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) ordered Overrides: findSerializationSortAlphabetically in class AnnotationIntrospector findSerializationConverter public Object findSerializationConverter(Annotated a) Description copied from class: AnnotationIntrospector Method for finding Converter that annotated entity (property or class) has indicated to be used as part of serialization. If not null, either has to be actual Converter instance, or class for such converter; and resulting converter will be used first to convert property value to converter target type, and then serializer for that type is used for actual serialization. This feature is typically used to convert internal values into types that Jackson can convert. Note also that this feature does not necessarily work well with polymorphic type handling, or object identity handling; if such features are needed an explicit serializer is usually better way to handle serialization. Overrides: findSerializationConverter in class AnnotationIntrospector Parameters: a - Annotated property (field, method) or class to check for annotations findSerializationContentConverter public Object findSerializationContentConverter(AnnotatedMember a) Description copied from class: AnnotationIntrospector Method for finding Converter that annotated property has indicated needs to be used for values of container type (this also means that method should only be called for properties of container types, List/Map/array properties). If not null, either has to be actual Converter instance, or class for such converter; and resulting converter will be used first to convert property value to converter target type, and then serializer for that type is used for actual serialization. Other notes are same as those for AnnotationIntrospector.findSerializationConverter(com.fasterxml.jackson.databind.introspect.Annotated) Overrides: findSerializationContentConverter in class AnnotationIntrospector Parameters: a - Annotated property (field, method) to check. findNameForSerialization public PropertyName findNameForSerialization(Annotated a) Description copied from class: AnnotationIntrospector Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for serialization. Should return null if no annotation is found; otherwise a non-null name (possibly PropertyName.USE_DEFAULT, which means "use default heuristics"). Overrides: findNameForSerialization in class AnnotationIntrospector Parameters: a - Property accessor to check Returns: Name to use if found; null if not. hasAsValueAnnotation public boolean hasAsValueAnnotation(AnnotatedMethod am) Description copied from class: AnnotationIntrospector Method for checking whether given method has an annotation that suggests that the return value of annotated method should be used as "the value" of the object instance; usually serialized as a primitive value such as String or number. Overrides: hasAsValueAnnotation in class AnnotationIntrospector Returns: True if such annotation is found (and is not disabled); false if no enabled annotation is found findEnumValue @Deprecated public String findEnumValue(Enum<?> e) Deprecated. This is very slow implementation, but as of Jackson 2.7, should not be called any more; instead, findEnumValues(java.lang.Class<?>, java.lang.Enum<?>[], java.lang.String[]) should be called which has less overhead. Overrides: findEnumValue in class AnnotationIntrospector Returns: Serialized enum value. findEnumValues public String[] findEnumValues(Class<?> enumType, Enum<?>[] enumValues, String[] names) Description copied from class: AnnotationIntrospector Method for efficiently figuring out which if given set of Enum values have explicitly defined name. Method will overwrite entries in incoming names array with explicit names found, if any, leaving other entries unmodified. Default implementation will simply delegate to AnnotationIntrospector.findEnumValue(java.lang.Enum<?>), which is close enough, although unfortunately NOT 100% equivalent (as it will also consider name() to give explicit value). Overrides: findEnumValues in class AnnotationIntrospector findDeserializer public Object findDeserializer(Annotated am) Description copied from class: AnnotationIntrospector Method for getting a deserializer definition on specified method or field. Type of definition is either instance (of type JsonDeserializer) or Class (of type Class<JsonDeserializer>); if value of different type is returned, a runtime exception may be thrown by caller. Overrides: findDeserializer in class AnnotationIntrospector findKeyDeserializer public Object findKeyDeserializer(Annotated am) Description copied from class: AnnotationIntrospector Method for getting a deserializer definition for keys of associated Map property. Type of definition is either instance (of type JsonDeserializer) or Class (of type Class<JsonDeserializer>); if value of different type is returned, a runtime exception may be thrown by caller. Overrides: findKeyDeserializer in class AnnotationIntrospector findContentDeserializer public Object findContentDeserializer(Annotated a) Description copied from class: AnnotationIntrospector Method for getting a deserializer definition for content (values) of associated Collection, array or Map property. Type of definition is either instance (of type JsonDeserializer) or Class (of type Class<JsonDeserializer>); if value of different type is returned, a runtime exception may be thrown by caller. Overrides: findContentDeserializer in class AnnotationIntrospector findDeserializationType @Deprecated public Class<?> findDeserializationType(Annotated a, JavaType baseType) Deprecated. JAXB does allow specifying (more) concrete class for deserialization by using \@XmlElement annotation. Overrides: findDeserializationType in class AnnotationIntrospector baseType - Assumed type before considering annotations Returns: Class to use for deserialization instead of declared type findDeserializationContentType @Deprecated public Class<?> findDeserializationContentType(Annotated a, JavaType baseContentType) Deprecated. Description copied from class: AnnotationIntrospector Method for accessing additional narrowing type definition that a method can have, to define more specific content type to use; content refers to Map values and Collection/array elements. It should be only be used with Map, Collection and array types. Overrides: findDeserializationContentType in class AnnotationIntrospector baseContentType - Assumed content (value) type before considering annotations Returns: Class specifying more specific type to use instead of declared type, if annotation found; null if not _doFindDeserializationType protected Class<?> _doFindDeserializationType(Annotated a, JavaType baseType) refineDeserializationType public JavaType refineDeserializationType(MapperConfig<?> config, Annotated a, JavaType baseType) throws JsonMappingException Description copied from class: AnnotationIntrospector Method called to find out possible type refinements to use for deserialization. Overrides: refineDeserializationType in class AnnotationIntrospector Throws: JsonMappingException findNameForDeserialization public PropertyName findNameForDeserialization(Annotated a) Description copied from class: AnnotationIntrospector Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for deserialization (reading JSON into POJOs). Should return null if no annotation is found; otherwise a non-null name (possibly PropertyName.USE_DEFAULT, which means "use default heuristics"). Overrides: findNameForDeserialization in class AnnotationIntrospector Parameters: a - Property accessor to check Returns: Name to use if found; null if not. hasCreatorAnnotation public boolean hasCreatorAnnotation(Annotated am) Description copied from class: AnnotationIntrospector Method for checking whether given annotated item (method, constructor) has an annotation that suggests that the method is a "creator" (aka factory) method to be used for construct new instances of deserialized values. Overrides: hasCreatorAnnotation in class AnnotationIntrospector Returns: True if such annotation is found (and is not disabled), false otherwise findDeserializationConverter public Object findDeserializationConverter(Annotated a) Description copied from class: AnnotationIntrospector Method for finding Converter that annotated entity (property or class) has indicated to be used as part of deserialization. If not null, either has to be actual Converter instance, or class for such converter; and resulting converter will be used after Jackson has deserializer data into intermediate type (Converter input type), and Converter needs to convert this into its target type to be set as property value. This feature is typically used to convert intermediate Jackson types (that default deserializers can produce) into custom type instances. Note also that this feature does not necessarily work well with polymorphic type handling, or object identity handling; if such features are needed an explicit deserializer is usually better way to handle deserialization. Overrides: findDeserializationConverter in class AnnotationIntrospector Parameters: a - Annotated property (field, method) or class to check for annotations findDeserializationContentConverter public Object findDeserializationContentConverter(AnnotatedMember a) Description copied from class: AnnotationIntrospector Method for finding Converter that annotated property has indicated needs to be used for values of container type (this also means that method should only be called for properties of container types, List/Map/array properties). If not null, either has to be actual Converter instance, or class for such converter; and resulting converter will be used after Jackson has deserializer data into intermediate type (Converter input type), and Converter needs to convert this into its target type to be set as property value. Other notes are same as those for AnnotationIntrospector.findDeserializationConverter(com.fasterxml.jackson.databind.introspect.Annotated) Overrides: findDeserializationContentConverter in class AnnotationIntrospector Parameters: a - Annotated property (field, method) to check. isJAXBAnnotation protected boolean isJAXBAnnotation(Annotation ann) An annotation is handled if it's in the same package as @XmlElement, including subpackages. Parameters: ann - The annotation. Returns: Whether the annotation is in the JAXB package. getTypeFactory protected final TypeFactory getTypeFactory() _findContentAdapter protected XmlAdapter<?,?> _findContentAdapter(Annotated ann, boolean forSerialization) _propertyNameToString protected String _propertyNameToString(PropertyName n) _rawDeserializationType protected Class<?> _rawDeserializationType(Annotated a) _fullDeserializationType protected JavaType _fullDeserializationType(AnnotatedMember am) _rawSerializationType protected Class<?> _rawSerializationType(Annotated a) _fullSerializationType protected JavaType _fullSerializationType(AnnotatedMember am) _converter protected Converter<Object,Object> _converter(XmlAdapter<?,?> adapter, boolean forSerialization) _getTypeFromXmlElement protected Class<?> _getTypeFromXmlElement(Annotated a)

Class JaxbAnnotationIntrospector

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.AnnotationIntrospector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.fasterxml.jackson.databind.AnnotationIntrospector

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_NAME_FOR_XML_VALUE

DEFAULT_IGNORE_XMLIDREF

MARKER_FOR_DEFAULT

FORMAT_STRING

FORMAT_INT

_jaxbPackageName

_dataHandlerSerializer

_dataHandlerDeserializer

_typeFactory

_ignoreXmlIDREF

_xmlValueName

_nonNillableInclusion

Constructor Detail

JaxbAnnotationIntrospector

JaxbAnnotationIntrospector

JaxbAnnotationIntrospector

JaxbAnnotationIntrospector

Method Detail

version

setNameUsedForXmlValue

getNameUsedForXmlValue

setNonNillableInclusion

getNonNillableInclusion

findNamespace

isOutputAsAttribute

isOutputAsText

findObjectIdInfo

findObjectReferenceInfo

findRootName

isIgnorableType

hasIgnoreMarker

hasRequiredMarker

findWrapperName

findImplicitPropertyName

findFormat

findAutoDetectVisibility

findAccessType

findTypeResolver

findPropertyTypeResolver

findPropertyContentTypeResolver

_typeResolverFromXmlElements

findSubtypes

findTypeName

findSerializer

findContentSerializer

findSerializationType

findSerializationInclusion

findPropertyInclusion

refineSerializationType

findSerializationPropertyOrder

findSerializationSortAlphabetically

findSerializationConverter

findSerializationContentConverter

findNameForSerialization

hasAsValueAnnotation

findEnumValue

findEnumValues

findDeserializer

findKeyDeserializer

findContentDeserializer

findDeserializationType

findDeserializationContentType

_doFindDeserializationType

refineDeserializationType

findNameForDeserialization

hasCreatorAnnotation

findDeserializationConverter

findDeserializationContentConverter

isJAXBAnnotation

getTypeFactory

_findContentAdapter