com.fasterxml.jackson.databind
Class AnnotationIntrospector.Pair

java.lang.Object
  com.fasterxml.jackson.databind.AnnotationIntrospector
      com.fasterxml.jackson.databind.AnnotationIntrospector.Pair

All Implemented Interfaces:

com.fasterxml.jackson.core.Versioned

Enclosing class:

AnnotationIntrospector

public static class AnnotationIntrospector.Pair
extends AnnotationIntrospector

Helper class that allows using 2 introspectors such that one introspector acts as the primary one to use; and second one as a fallback used if the primary does not provide conclusive or useful result for a method.

An obvious consequence of priority is that it is easy to construct longer chains of introspectors by linking multiple pairs. Currently most likely combination is that of using the default Jackson provider, along with JAXB annotation introspector.

Nested Class Summary

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

AnnotationIntrospector.Pair, AnnotationIntrospector.ReferenceProperty

Field Summary

protected AnnotationIntrospector	_primary
protected AnnotationIntrospector	_secondary

Constructor Summary

AnnotationIntrospector.Pair(AnnotationIntrospector p, AnnotationIntrospector s)

Method Summary

Collection<AnnotationIntrospector>	allIntrospectors() Method that can be used to collect all "real" introspectors that this introspector contains, if any; or this introspector if it is not a container.
Collection<AnnotationIntrospector>	allIntrospectors(Collection<AnnotationIntrospector> result) Method that can be used to collect all "real" introspectors that this introspector contains, if any; or this introspector if it is not a container.
static AnnotationIntrospector	create(AnnotationIntrospector primary, AnnotationIntrospector secondary) Helper method for constructing a Pair from two given introspectors (if neither is null); or returning non-null introspector if one is null (and return just null if both are null)
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 am) 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.
Class<?>	findDeserializationContentType(Annotated am, JavaType baseContentType) 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.
Class<?>	findDeserializationKeyType(Annotated am, JavaType baseKeyType) Method for accessing additional narrowing type definition that a method can have, to define more specific key type to use.
String	findDeserializationName(AnnotatedField af) Method for checking whether given member field represent a deserializable logical property; and if so, returns the name of that property.
String	findDeserializationName(AnnotatedMethod am) Method for checking whether given method has an annotation that suggests property name associated with method that may be a "setter".
String	findDeserializationName(AnnotatedParameter param) Method for checking whether given set of annotations indicates property name for associated parameter.
Class<?>	findDeserializationType(Annotated am, JavaType baseType) Method for accessing annotated type definition that a method can have, to be used as the type for serialization instead of the runtime type.
Object	findDeserializer(Annotated am) Method for getting a deserializer definition on specified method or field.
String	findEnumValue(Enum<?> value) Method for determining the String value to use for serializing given enumeration entry; used when serializing enumerations as Strings (the standard method).
Object	findFilterId(AnnotatedClass ac) Method for finding if annotated class has associated filter; and if so, to return id that is used to locate filter.
com.fasterxml.jackson.annotation.JsonFormat.Value	findFormat(AnnotatedMember member) Method for finding format annotations for given member.
Boolean	findIgnoreUnknownProperties(AnnotatedClass ac) Method for checking whether an annotation indicates that all unknown properties
Object	findInjectableValueId(AnnotatedMember m) Method called to find out whether given member expectes a value to be injected, and if so, what is the identifier of the value to use during injection.
Object	findKeyDeserializer(Annotated am) Method for getting a deserializer definition for keys of associated Map property.
Object	findKeySerializer(Annotated a) Method for getting a serializer definition for keys of associated Map property.
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.
Class<?>	findPOJOBuilder(AnnotatedClass ac) Method for finding Builder object to use for constructing value instance and binding data (sort of combining value instantiators that can construct, and deserializers that can bind data).
JsonPOJOBuilder.Value	findPOJOBuilderConfig(AnnotatedClass ac)
String[]	findPropertiesToIgnore(Annotated ac) Method for finding list of properties to ignore for given class (null is returned if not specified).
TypeResolverBuilder<?>	findPropertyContentTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType baseType) 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.
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.
AnnotationIntrospector.ReferenceProperty	findReferenceType(AnnotatedMember member) Method for checking if given member indicates that it is part of a reference (parent/child).
String	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.
Class<?>	findSerializationContentType(Annotated am, JavaType baseType) Method for finding possible widening type definition that a property value can have, to define less specific key type to use for serialization.
com.fasterxml.jackson.annotation.JsonInclude.Include	findSerializationInclusion(Annotated a, com.fasterxml.jackson.annotation.JsonInclude.Include defValue) Method for checking whether given annotated entity (class, method, field) defines which Bean/Map properties are to be included in serialization.
Class<?>	findSerializationKeyType(Annotated am, JavaType baseType) Method for finding possible widening type definition that a property value can have, to define less specific key type to use for serialization.
String	findSerializationName(AnnotatedField af) Method for checking whether given member field represent a serializable logical property; and if so, returns the name of that property.
String	findSerializationName(AnnotatedMethod am) Method for checking whether given method has an annotation that suggests property name associated with method that may be a "getter".
String[]	findSerializationPropertyOrder(AnnotatedClass ac) Method for accessing defined property serialization order (which may be partial).
Boolean	findSerializationSortAlphabetically(AnnotatedClass ac) 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) 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.
JsonSerialize.Typing	findSerializationTyping(Annotated a) Method for accessing declared typing mode annotated (if any).
Object	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.
NameTransformer	findUnwrappingNameTransformer(AnnotatedMember member) Method called to check whether given property is marked to be "unwrapped" when being serialized (and appropriately handled in reverse direction, i.e.
Object	findValueInstantiator(AnnotatedClass ac) Method getting ValueInstantiator to use for given type (class): return value can either be an instance of instantiator, or class of instantiator to create.
Class<?>[]	findViews(Annotated a) Method for checking if annotated property (represented by a field or getter/setter method) has definitions for views it is to be included in.
boolean	hasAnyGetterAnnotation(AnnotatedMethod am) Method for checking whether given method has an annotation that suggests that the method is to serve as "any setter"; method to be used for accessing set of miscellaneous "extra" properties, often bound with matching "any setter" method.
boolean	hasAnySetterAnnotation(AnnotatedMethod am) Method for checking whether given method has an annotation that suggests that the method is to serve as "any setter"; method to be used for setting values of any properties for which no dedicated setter method is found.
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 a) 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	isAnnotationBundle(Annotation ann) Method for checking whether given annotation is considered an annotation bundle: if so, all meta-annotations it has will be used instead of annotation ("bundle") itself.
boolean	isHandled(Annotation ann) Method called by framework to determine whether given annotation is handled by this introspector.
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.
Boolean	isTypeId(AnnotatedMember member) Method for checking whether given accessor claims to represent type id: if so, its value may be used as an override, instead of generated type id.
com.fasterxml.jackson.core.Version	version()

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

nopInstance, pair

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_primary

protected final AnnotationIntrospector _primary

_secondary

protected final AnnotationIntrospector _secondary

Constructor Detail

AnnotationIntrospector.Pair

public AnnotationIntrospector.Pair(AnnotationIntrospector p,
                                   AnnotationIntrospector s)

Method Detail

version

public com.fasterxml.jackson.core.Version version()

Specified by:

version in interface com.fasterxml.jackson.core.Versioned

Specified by:

version in class AnnotationIntrospector

create

public static AnnotationIntrospector create(AnnotationIntrospector primary,
                                            AnnotationIntrospector secondary)

Helper method for constructing a Pair from two given introspectors (if neither is null); or returning non-null introspector if one is null (and return just null if both are null)

allIntrospectors

public Collection<AnnotationIntrospector> allIntrospectors()

Description copied from class: AnnotationIntrospector

Method that can be used to collect all "real" introspectors that this introspector contains, if any; or this introspector if it is not a container. Used to get access to all container introspectors in their priority order.

Default implementation returns a Singleton list with this introspector as contents. This usually works for sub-classes, except for proxy or delegating "container introspectors" which need to override implementation.

Overrides:

allIntrospectors in class AnnotationIntrospector

allIntrospectors

public Collection<AnnotationIntrospector> allIntrospectors(Collection<AnnotationIntrospector> result)

Description copied from class: AnnotationIntrospector

Method that can be used to collect all "real" introspectors that this introspector contains, if any; or this introspector if it is not a container. Used to get access to all container introspectors in their priority order.

Default implementation adds this introspector in result; this usually works for sub-classes, except for proxy or delegating "container introspectors" which need to override implementation.

Overrides:

allIntrospectors in class AnnotationIntrospector

isHandled

public boolean isHandled(Annotation ann)

Description copied from class: AnnotationIntrospector

Method called by framework to determine whether given annotation is handled by this introspector.

Overrides:

isHandled in class AnnotationIntrospector

isAnnotationBundle

public boolean isAnnotationBundle(Annotation ann)

Description copied from class: AnnotationIntrospector

Method for checking whether given annotation is considered an annotation bundle: if so, all meta-annotations it has will be used instead of annotation ("bundle") itself.

Overrides:

isAnnotationBundle in class AnnotationIntrospector

findRootName

public String 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.

Overrides:

findRootName in class AnnotationIntrospector

findPropertiesToIgnore

public String[] findPropertiesToIgnore(Annotated ac)

Description copied from class: AnnotationIntrospector

Method for finding list of properties to ignore for given class (null is returned if not specified). List of property names is applied after other detection mechanisms, to filter out these specific properties from being serialized and deserialized.

Overrides:

findPropertiesToIgnore in class AnnotationIntrospector

findIgnoreUnknownProperties

public Boolean findIgnoreUnknownProperties(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method for checking whether an annotation indicates that all unknown properties

Overrides:

findIgnoreUnknownProperties 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')

findFilterId

public Object findFilterId(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method for finding if annotated class has associated filter; and if so, to return id that is used to locate filter.

Overrides:

findFilterId in class AnnotationIntrospector

Returns:

Id of the filter to use for filtering properties of annotated class, if any; or null if none found.

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

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 baseType)

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

baseType - 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

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

findReferenceType

public AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)

Description copied from class: AnnotationIntrospector

Method for checking if given member indicates that it is part of a reference (parent/child).

Overrides:

findReferenceType in class AnnotationIntrospector

findUnwrappingNameTransformer

public NameTransformer findUnwrappingNameTransformer(AnnotatedMember member)

Description copied from class: AnnotationIntrospector

Method called to check whether given property is marked to be "unwrapped" when being serialized (and appropriately handled in reverse direction, i.e. expect unwrapped representation during deserialization). Return value is the name transformation to use, if wrapping/unwrapping should be done, or null if not -- note that transformation may simply be identity transformation (no changes).

Overrides:

findUnwrappingNameTransformer in class AnnotationIntrospector

findInjectableValueId

public Object findInjectableValueId(AnnotatedMember m)

Description copied from class: AnnotationIntrospector

Method called to find out whether given member expectes a value to be injected, and if so, what is the identifier of the value to use during injection. Type if identifier needs to be compatible with provider of values (of type InjectableValues); often a simple String id is used.

Overrides:

findInjectableValueId in class AnnotationIntrospector

Parameters:

m - Member to check

Returns:

Identifier of value to inject, if any; null if no injection indicator is found

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

findSerializer

public Object 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); if value of different type is returned, a runtime exception may be thrown by caller.

Overrides:

findSerializer in class AnnotationIntrospector

findKeySerializer

public Object findKeySerializer(Annotated a)

Description copied from class: AnnotationIntrospector

Method for getting a serializer definition for keys of associated Map property. Type of definition is either instance (of type JsonSerializer) or Class (of type Class); if value of different type is returned, a runtime exception may be thrown by caller.

Overrides:

findKeySerializer 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); if value of different type is returned, a runtime exception may be thrown by caller.

Overrides:

findContentSerializer in class AnnotationIntrospector

findSerializationInclusion

public com.fasterxml.jackson.annotation.JsonInclude.Include findSerializationInclusion(Annotated a,
                                                                                       com.fasterxml.jackson.annotation.JsonInclude.Include defValue)

Description copied from class: AnnotationIntrospector

Method for checking whether given annotated entity (class, method, field) defines which Bean/Map properties are to be included in serialization. If no annotation is found, method should return given second argument; otherwise value indicated by the annotation

Overrides:

findSerializationInclusion in class AnnotationIntrospector

Returns:

Enumerated value indicating which properties to include in serialization

findSerializationType

public Class<?> findSerializationType(Annotated a)

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

findSerializationKeyType

public Class<?> findSerializationKeyType(Annotated am,
                                         JavaType baseType)

Description copied from class: AnnotationIntrospector

Method for finding possible widening type definition that a property value can have, to define less specific key type to use for serialization. It should be only be used with Map types.

Overrides:

findSerializationKeyType in class AnnotationIntrospector

Returns:

Class specifying more general type to use instead of declared type, if annotation found; null if not

findSerializationContentType

public Class<?> findSerializationContentType(Annotated am,
                                             JavaType baseType)

Description copied from class: AnnotationIntrospector

Method for finding possible widening type definition that a property value can have, to define less specific key type to use for serialization. It should be only used with structured types (arrays, collections, maps).

Overrides:

findSerializationContentType in class AnnotationIntrospector

Returns:

Class specifying more general type to use instead of declared type, if annotation found; null if not

findSerializationTyping

public JsonSerialize.Typing findSerializationTyping(Annotated a)

Description copied from class: AnnotationIntrospector

Method for accessing declared typing mode annotated (if any). This is used for type detection, unless more granular settings (such as actual exact type; or serializer to use which means no type information is needed) take precedence.

Overrides:

findSerializationTyping in class AnnotationIntrospector

Returns:

Typing mode to use, if annotation is found; null otherwise

findViews

public Class<?>[] findViews(Annotated a)

Description copied from class: AnnotationIntrospector

Method for checking if annotated property (represented by a field or getter/setter method) has definitions for views it is to be included in. If null is returned, no view definitions exist and property is always included (or always excluded as per default view inclusion configuration); otherwise it will only be included for views included in returned array. View matches are checked using class inheritance rules (sub-classes inherit inclusions of super-classes)

Overrides:

findViews in class AnnotationIntrospector

Parameters:

a - Annotated property (represented by a method, field or ctor parameter)

Returns:

Array of views (represented by classes) that the property is included in; if null, always included (same as returning array containing Object.class)

isTypeId

public Boolean isTypeId(AnnotatedMember member)

Description copied from class: AnnotationIntrospector

Method for checking whether given accessor claims to represent type id: if so, its value may be used as an override, instead of generated type id.

Overrides:

isTypeId in class AnnotationIntrospector

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

findFormat

public com.fasterxml.jackson.annotation.JsonFormat.Value findFormat(AnnotatedMember member)

Description copied from class: AnnotationIntrospector

Method for finding format annotations for given member. Return value is typically used by serializers and/or deserializers to customize presentation aspects of the serialized value.

Overrides:

findFormat in class AnnotationIntrospector

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(AnnotatedClass ac)

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

findSerializationName

public String findSerializationName(AnnotatedMethod am)

Description copied from class: AnnotationIntrospector

Method for checking whether given method has an annotation that suggests property name associated with method that may be a "getter". Should return null if no annotation is found; otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use standard bean name detection if applicable; method name if not".

Overrides:

findSerializationName in class AnnotationIntrospector

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

public String findEnumValue(Enum<?> value)

Description copied from class: AnnotationIntrospector

Method for determining the String value to use for serializing given enumeration entry; used when serializing enumerations as Strings (the standard method).

Overrides:

findEnumValue in class AnnotationIntrospector

Returns:

Serialized enum value.

findSerializationName

public String findSerializationName(AnnotatedField af)

Description copied from class: AnnotationIntrospector

Method for checking whether given member field represent a serializable logical property; and if so, returns the name of that property. Should return null if no annotation is found (indicating it is not a serializable field); otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use the field name as is".

Overrides:

findSerializationName 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); 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); 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 am)

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); if value of different type is returned, a runtime exception may be thrown by caller.

Overrides:

findContentDeserializer in class AnnotationIntrospector

findDeserializationType

public Class<?> findDeserializationType(Annotated am,
                                        JavaType baseType)

Description copied from class: AnnotationIntrospector

Method for accessing annotated type definition that a method can have, to be used as the type for serialization instead of the runtime type. Type must be a narrowing conversion (i.e.subtype of declared type). Declared return type of the method is also considered acceptable.

Overrides:

findDeserializationType in class AnnotationIntrospector

baseType - Assumed type before considering annotations

Returns:

Class to use for deserialization instead of declared type

findDeserializationKeyType

public Class<?> findDeserializationKeyType(Annotated am,
                                           JavaType baseKeyType)

Description copied from class: AnnotationIntrospector

Method for accessing additional narrowing type definition that a method can have, to define more specific key type to use. It should be only be used with Map types.

Overrides:

findDeserializationKeyType in class AnnotationIntrospector

baseKeyType - Assumed key type before considering annotations

Returns:

Class specifying more specific type to use instead of declared type, if annotation found; null if not

findDeserializationContentType

public Class<?> findDeserializationContentType(Annotated am,
                                               JavaType baseContentType)

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

findValueInstantiator

public Object findValueInstantiator(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method getting ValueInstantiator to use for given type (class): return value can either be an instance of instantiator, or class of instantiator to create.

Overrides:

findValueInstantiator in class AnnotationIntrospector

findPOJOBuilder

public Class<?> findPOJOBuilder(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method for finding Builder object to use for constructing value instance and binding data (sort of combining value instantiators that can construct, and deserializers that can bind data).

Note that unlike accessors for some helper Objects, this method does not allow returning instances: the reason is that builders have state, and a separate instance needs to be created for each deserialization call.

Overrides:

findPOJOBuilder in class AnnotationIntrospector

findPOJOBuilderConfig

public JsonPOJOBuilder.Value findPOJOBuilderConfig(AnnotatedClass ac)

Overrides:

findPOJOBuilderConfig in class AnnotationIntrospector

findDeserializationName

public String findDeserializationName(AnnotatedMethod am)

Description copied from class: AnnotationIntrospector

Method for checking whether given method has an annotation that suggests property name associated with method that may be a "setter". Should return null if no annotation is found; otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use standard bean name detection if applicable; method name if not".

Overrides:

findDeserializationName in class AnnotationIntrospector

hasAnySetterAnnotation

public boolean hasAnySetterAnnotation(AnnotatedMethod am)

Description copied from class: AnnotationIntrospector

Method for checking whether given method has an annotation that suggests that the method is to serve as "any setter"; method to be used for setting values of any properties for which no dedicated setter method is found.

Overrides:

hasAnySetterAnnotation in class AnnotationIntrospector

Returns:

True if such annotation is found (and is not disabled), false otherwise

hasAnyGetterAnnotation

public boolean hasAnyGetterAnnotation(AnnotatedMethod am)

Description copied from class: AnnotationIntrospector

Method for checking whether given method has an annotation that suggests that the method is to serve as "any setter"; method to be used for accessing set of miscellaneous "extra" properties, often bound with matching "any setter" method.

Overrides:

hasAnyGetterAnnotation in class AnnotationIntrospector

Returns:

True if such annotation is found (and is not disabled), false otherwise

hasCreatorAnnotation

public boolean hasCreatorAnnotation(Annotated a)

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

findDeserializationName

public String findDeserializationName(AnnotatedField af)

Description copied from class: AnnotationIntrospector

Method for checking whether given member field represent a deserializable logical property; and if so, returns the name of that property. Should return null if no annotation is found (indicating it is not a deserializable field); otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use the field name as is".

Overrides:

findDeserializationName in class AnnotationIntrospector

findDeserializationName

public String findDeserializationName(AnnotatedParameter param)

Description copied from class: AnnotationIntrospector

Method for checking whether given set of annotations indicates property name for associated parameter. No actual parameter object can be passed since JDK offers no representation; just annotations.

Overrides:

findDeserializationName in class AnnotationIntrospector