Class JacksonAnnotationIntrospector
- All Implemented Interfaces:
Versioned
,Serializable
AnnotationIntrospector
implementation that handles standard
Jackson annotations.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.AnnotationIntrospector
AnnotationIntrospector.ReferenceProperty, AnnotationIntrospector.XmlExtensions
-
Field Summary
Modifier and TypeFieldDescriptionSince introspection of annotation types is a performance issue in some use cases (rare, but do exist), let's try a simple cache to reduce need for actual meta-annotation introspection.protected boolean
SeesetConstructorPropertiesImpliesCreator(boolean)
for explanation. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected Class<?>
_classIfExplicit
(Class<?> cls) protected Class<?>
_classIfExplicit
(Class<?> cls, Class<?> implicit) protected StdTypeResolverBuilder
Helper method for dealing with "no type info" marker; can't be null (as it'd be replaced by default typing)protected StdTypeResolverBuilder
Helper method for constructing standardTypeResolverBuilder
implementation.protected BeanPropertyWriter
_constructVirtualProperty
(JsonAppend.Attr attr, MapperConfig<?> config, AnnotatedClass ac, JavaType type) protected BeanPropertyWriter
_constructVirtualProperty
(JsonAppend.Prop prop, MapperConfig<?> config, AnnotatedClass ac) protected PropertyName
protected TypeResolverBuilder<?>
_findTypeResolver
(MapperConfig<?> config, Annotated ann, JavaType baseType) Helper method called to construct and initialize instance ofTypeResolverBuilder
if given annotated element indicates one is needed.protected boolean
protected PropertyName
_propertyName
(String localName, String namespace) void
findAndAddVirtualProperties
(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties) Method for adding possible virtual properties to be serialized along with regular properties.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).Method used to check whether specified class defines a human-readable description to use for documentation.Method for getting a deserializer definition for content (values) of associatedCollection
,array
orMap
property.Method for getting a serializer definition for content (values) of associatedCollection
,array
orMap
property.findCreatorAnnotation
(MapperConfig<?> config, Annotated a) Method called to check whether potential Creator (constructor or static factory method) has explicit annotation to indicate it as actual Creator; and if so, whichJsonCreator.Mode
to use.Deprecated.Enum<?>
findDefaultEnumValue
(Class<Enum<?>> enumCls) Finds the Enum value that should be considered the default value, if possible.Method for findingConverter
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 am, JavaType baseContentType) Deprecated.Method for findingConverter
that annotated entity (property or class) has indicated to be used as part of deserialization.Class<?>
findDeserializationKeyType
(Annotated am, JavaType baseKeyType) Deprecated.Class<?>
findDeserializationType
(Annotated am, JavaType baseType) Deprecated.Method for getting a deserializer definition on specified method or field.void
findEnumAliases
(Class<?> enumType, Enum<?>[] enumValues, String[][] aliasList) Method that is related toAnnotationIntrospector.findEnumValues(java.lang.Class<?>, java.lang.Enum<?>[], java.lang.String[])
but is called to check if there are alternative names (aliased) that can be accepted for entries, in addition to primary names introspected earlier.findEnumValue
(Enum<?> value) Deprecated.String[]
findEnumValues
(Class<?> enumType, Enum<?>[] enumValues, String[] names) Method for efficiently figuring out which if given set ofEnum
values have explicitly defined name.Method for finding if annotated class has associated filter; and if so, to return id that is used to locate filter.findFormat
(Annotated ann) Method for finding format annotations for property or class.Method for finding implicit name for a property that given annotated member (field, method, creator parameter) may represent.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.Deprecated.Method for getting a deserializer definition for keys of associatedMap
property.Method for getting a serializer definition for keys of associatedjava.util.Map
property.Method for finding merge settings for property, if any.Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for deserialization (reading JSON into POJOs).Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for serialization.Method for findingPropertyNamingStrategy
for given class, if any specified by annotations; and if so, either return aPropertyNamingStrategy
instance, or Class to use for creating instanceMethod for getting a serializer definition for serializer to use for nulls (null values) of associated property or type.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.findObjectReferenceInfo
(Annotated ann, ObjectIdInfo objectIdInfo) Method for figuring out additional properties of an Object Identity referenceClass<?>
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).Method for finding optional access definition for a property, annotated on one of its accessors.Method called to find if given property has alias(es) defined.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.Method for finding suggested default value (as simple textual serialization) for the property.Method used to check whether specified property member (accessor or mutator) defines human-readable description to use for documentation.findPropertyIgnoralByName
(MapperConfig<?> config, Annotated a) Method for finding information about properties to ignore either by name, or by more general specification ("ignore all unknown").Deprecated.Method for checking inclusion criteria for a type (Class) or property (yes, method name is bit unfortunate -- not just for properties!).findPropertyInclusionByName
(MapperConfig<?> config, Annotated a) Method for finding information about names of properties to included.Method used to check whether specified property member (accessor or mutator) defines numeric index, and if so, what is the index value.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.findReferenceType
(AnnotatedMember member) Method for checking if given member indicates that it is part of a reference (parent/child).findRenameByField
(MapperConfig<?> config, AnnotatedField f, PropertyName implName) Method called on fields that are eligible candidates for properties (that is, non-static member fields), but not necessarily selected (may or may not be visible), to let fields affect name linking.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.Method for findingConverter
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<?>
findSerializationContentType
(Annotated am, JavaType baseType) Deprecated.Method for findingConverter
that annotated entity (property or class) has indicated to be used as part of serialization.Class<?>
findSerializationKeyType
(Annotated am, JavaType baseType) Deprecated.String[]
Method for accessing defined property serialization order (which may be partial).Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) orderedClass<?>
Deprecated.Method for accessing declared typing mode annotated (if any).Method for getting a serializer definition on specified method or field.Method for finding possible settings for property, given annotations on an accessor.Method for locating annotation-specified subtypes related to annotated entity (class, method, field).Method for checking if specified type has explicit name.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.Method called to check whether given property is marked to be "unwrapped" when being serialized (and appropriately handled in reverse direction, i.e.Method gettingValueInstantiator
to use for given type (class): return value can either be an instance of instantiator, or class of instantiator to create.Class<?>[]
Method for checking if annotated property (represented by a field or getter/setter method) has definitions for views it is to be included in.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
Deprecated.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
Deprecated.hasAsKey
(MapperConfig<?> config, Annotated a) Method for checking whether given method has an annotation that suggests the return value of annotated field or method should be used as "the key" of the object instance; usually serialized as a primitive value such as String or number.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
Deprecated.boolean
Deprecated.boolean
Method called to check whether given property is marked to be ignored.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
Annotations with meta-annotationJacksonAnnotationsInside
are considered bundles.Method for checking whether properties that have specified type (class, not generics aware) should be completely ignored for serialization and deserialization purposes.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.protected Object
refineDeserializationType
(MapperConfig<?> config, Annotated a, JavaType baseType) Method called to find out possible type refinements to use for deserialization.refineSerializationType
(MapperConfig<?> config, Annotated a, JavaType baseType) Method called to find out possible type refinements to use for deserialization, including not just value itself but key and/or content type, if type has those.resolveSetterConflict
(MapperConfig<?> config, AnnotatedMethod setter1, AnnotatedMethod setter2) Specific implementation that will use following tie-breaker on given setter parameter types: If either one is primitive type then either returnnull
(both primitives) or one that is primitive (when only primitive) If only one is of typeString
, return that setter Otherwise returnnull
Returningnull
will indicate that resolution could not be done.setConstructorPropertiesImpliesCreator
(boolean b) Method for changing behavior ofConstructorProperties
: if set to `true`, existence DOES indicate that the given constructor should be considered a creator; `false` that it should NOT be considered a creator without explicit use ofJsonCreator
annotation.version()
Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (seeVersion
for details).Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.AnnotationIntrospector
_findAnnotation, _hasAnnotation, _hasOneOf, allIntrospectors, allIntrospectors, findIgnoreUnknownProperties, findPropertiesToIgnore, findSerializationInclusion, findSerializationInclusionForContent, findWrapperName, nopInstance, pair
-
Field Details
-
_annotationsInside
Since introspection of annotation types is a performance issue in some use cases (rare, but do exist), let's try a simple cache to reduce need for actual meta-annotation introspection.Non-final only because it needs to be re-created after deserialization.
- Since:
- 2.7
-
_cfgConstructorPropertiesImpliesCreator
protected boolean _cfgConstructorPropertiesImpliesCreatorSeesetConstructorPropertiesImpliesCreator(boolean)
for explanation.Defaults to true.
- Since:
- 2.7.4
-
-
Constructor Details
-
JacksonAnnotationIntrospector
public JacksonAnnotationIntrospector()
-
-
Method Details
-
version
Description copied from interface:Versioned
Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (seeVersion
for details).- Specified by:
version
in interfaceVersioned
- Specified by:
version
in classAnnotationIntrospector
- Returns:
- Version of the component
-
readResolve
-
setConstructorPropertiesImpliesCreator
Method for changing behavior ofConstructorProperties
: if set to `true`, existence DOES indicate that the given constructor should be considered a creator; `false` that it should NOT be considered a creator without explicit use ofJsonCreator
annotation.Default setting is `true`
- Since:
- 2.7.4
-
isAnnotationBundle
Annotations with meta-annotationJacksonAnnotationsInside
are considered bundles.- Overrides:
isAnnotationBundle
in classAnnotationIntrospector
- Parameters:
ann
- Annotated entity to introspect- Returns:
- True if given annotation is considered an annotation bundle; false if not
-
findEnumValue
Deprecated.Since 2.6, we have supported use ofJsonProperty
for specifying explicit serialized name- Overrides:
findEnumValue
in classAnnotationIntrospector
- Parameters:
value
- Enum value to introspect- Returns:
- Serialized enum value.
-
findEnumValues
Description copied from class:AnnotationIntrospector
Method for efficiently figuring out which if given set ofEnum
values have explicitly defined name. Method will overwrite entries in incomingnames
array with explicit names found, if any, leaving other entries unmodified.- Overrides:
findEnumValues
in classAnnotationIntrospector
- Parameters:
enumType
- Type of EnumerationenumValues
- Values of enumerationnames
- Matching declared names of enumeration values (with indexes matchingenumValues
entries)- Returns:
- Array of names to use (possible
names
passed as argument)
-
findEnumAliases
Description copied from class:AnnotationIntrospector
Method that is related toAnnotationIntrospector.findEnumValues(java.lang.Class<?>, java.lang.Enum<?>[], java.lang.String[])
but is called to check if there are alternative names (aliased) that can be accepted for entries, in addition to primary names introspected earlier. If so, these aliases should be returned inaliases
List
passed as argument (and initialized for proper size by caller).- Overrides:
findEnumAliases
in classAnnotationIntrospector
- Parameters:
enumType
- Type of EnumerationenumValues
- Values of enumerationaliasList
- (in/out) Pre-allocated array where aliases found, if any, may be added (in indexes matching those ofenumValues
)
-
findDefaultEnumValue
Finds the Enum value that should be considered the default value, if possible.This implementation relies on
JsonEnumDefaultValue
annotation to determine the default value if present.- Overrides:
findDefaultEnumValue
in classAnnotationIntrospector
- Parameters:
enumCls
- The Enum class to scan for the default value.- Returns:
- null if none found or it's not possible to determine one.
- Since:
- 2.8
-
findRootName
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 classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspect- Returns:
- Root name to use, if any;
null
if not
-
isIgnorableType
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 classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspect- 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')
-
findPropertyIgnoralByName
Description copied from class:AnnotationIntrospector
Method for finding information about properties to ignore either by name, or by more general specification ("ignore all unknown"). This method combines multiple aspects of ignorals and deprecates earlier methods such asAnnotationIntrospector.findPropertiesToIgnore(Annotated, boolean)
andAnnotationIntrospector.findIgnoreUnknownProperties(AnnotatedClass)
.- Overrides:
findPropertyIgnoralByName
in classAnnotationIntrospector
- Parameters:
config
- Configuration settings in effect (for serialization or deserialization)a
- Annotated entity (Class, Accessor) to introspect- Returns:
- Property ignoral settings to use;
JsonIgnoreProperties.Value.empty()
for defaults (should not returnnull
)
-
findPropertyIgnorals
Deprecated.- Overrides:
findPropertyIgnorals
in classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspect- Returns:
- Property ignoral settings to use;
JsonIgnoreProperties.Value.empty()
for defaults (should not returnnull
)
-
findPropertyInclusionByName
Description copied from class:AnnotationIntrospector
Method for finding information about names of properties to included. This is typically used to strictly limit properties to include based on fully defined set of names ("allow-listing"), as opposed to excluding potential properties by exclusion ("deny-listing").- Overrides:
findPropertyInclusionByName
in classAnnotationIntrospector
- Parameters:
config
- Configuration settings in effect (for serialization or deserialization)a
- Annotated entity (Class, Accessor) to introspect- Returns:
- Property inclusion settings to use;
JsonIncludeProperties.Value.all()
for defaults (should not returnnull
)
-
findFilterId
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 classAnnotationIntrospector
- Parameters:
a
- Annotated entity to introspect- Returns:
- Id of the filter to use for filtering properties of annotated class, if any; or null if none found.
-
findNamingStrategy
Description copied from class:AnnotationIntrospector
Method for findingPropertyNamingStrategy
for given class, if any specified by annotations; and if so, either return aPropertyNamingStrategy
instance, or Class to use for creating instance- Overrides:
findNamingStrategy
in classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspect- Returns:
- Sub-class or instance of
PropertyNamingStrategy
, if one is specified for given class; null if not.
-
findClassDescription
Description copied from class:AnnotationIntrospector
Method used to check whether specified class defines a human-readable description to use for documentation. There are no further definitions for contents; for example, whether these may be marked up using HTML (or something like wiki format like Markup) is not defined.- Overrides:
findClassDescription
in classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspect- Returns:
- Human-readable description, if any.
-
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 classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspectchecker
- Default visibility settings in effect before any override- Returns:
- Visibility settings after possible annotation-based overrides
-
findImplicitPropertyName
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 cannot be detected by standard databind); or to provide alternate name mangling for fields, getters and/or setters.- Overrides:
findImplicitPropertyName
in classAnnotationIntrospector
-
findPropertyAliases
Description copied from class:AnnotationIntrospector
Method called to find if given property has alias(es) defined.- Overrides:
findPropertyAliases
in classAnnotationIntrospector
- Returns:
- `null` if member has no information; otherwise a `List` (possibly empty) of aliases to use.
-
hasIgnoreMarker
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 classAnnotationIntrospector
-
hasRequiredMarker
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 classAnnotationIntrospector
-
findPropertyAccess
Description copied from class:AnnotationIntrospector
Method for finding optional access definition for a property, annotated on one of its accessors. If a definition for read-only, write-only or read-write cases, visibility rules may be modified. Note, however, that even more specific annotations (like one for ignoring specific accessor) may further override behavior of the access definition.- Overrides:
findPropertyAccess
in classAnnotationIntrospector
-
findPropertyDescription
Description copied from class:AnnotationIntrospector
Method used to check whether specified property member (accessor or mutator) defines human-readable description to use for documentation. There are no further definitions for contents; for example, whether these may be marked up using HTML is not defined.- Overrides:
findPropertyDescription
in classAnnotationIntrospector
- Returns:
- Human-readable description, if any.
-
findPropertyIndex
Description copied from class:AnnotationIntrospector
Method used to check whether specified property member (accessor or mutator) defines numeric index, and if so, what is the index value. Possible use cases for index values included use by underlying data format (some binary formats mandate use of index instead of name) and ordering of properties (for documentation, or during serialization).- Overrides:
findPropertyIndex
in classAnnotationIntrospector
- Returns:
- Explicitly specified index for the property, if any
-
findPropertyDefaultValue
Description copied from class:AnnotationIntrospector
Method for finding suggested default value (as simple textual serialization) for the property. While core databind does not make any use of it, it is exposed for extension modules to use: an expected use is generation of schema representations and documentation.- Overrides:
findPropertyDefaultValue
in classAnnotationIntrospector
-
findFormat
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 classAnnotationIntrospector
-
findReferenceType
Description copied from class:AnnotationIntrospector
Method for checking if given member indicates that it is part of a reference (parent/child).- Overrides:
findReferenceType
in classAnnotationIntrospector
-
findUnwrappingNameTransformer
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 classAnnotationIntrospector
-
findInjectableValue
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 typeInjectableValues
); often a simple String id is used.- Overrides:
findInjectableValue
in classAnnotationIntrospector
- Parameters:
m
- Member to check- Returns:
- Identifier of value to inject, if any; null if no injection indicator is found
-
findInjectableValueId
Deprecated.- Overrides:
findInjectableValueId
in classAnnotationIntrospector
-
findViews
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)Since 2.9 this method may also be called to find "default view(s)" for
AnnotatedClass
- Overrides:
findViews
in classAnnotationIntrospector
- 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
)
-
resolveSetterConflict
public AnnotatedMethod resolveSetterConflict(MapperConfig<?> config, AnnotatedMethod setter1, AnnotatedMethod setter2) Specific implementation that will use following tie-breaker on given setter parameter types:- If either one is primitive type then either return
null
(both primitives) or one that is primitive (when only primitive) - If only one is of type
String
, return that setter - Otherwise return
null
null
will indicate that resolution could not be done.- Overrides:
resolveSetterConflict
in classAnnotationIntrospector
- If either one is primitive type then either return
-
findRenameByField
public PropertyName findRenameByField(MapperConfig<?> config, AnnotatedField f, PropertyName implName) Description copied from class:AnnotationIntrospector
Method called on fields that are eligible candidates for properties (that is, non-static member fields), but not necessarily selected (may or may not be visible), to let fields affect name linking. Call will be made after finding implicit name (which by default is just name of the field, but may be overridden by introspector), but before discovering other accessors. If non-null name returned, it is to be used to find other accessors (getters, setters, creator parameters) and replace their implicit names with that of field's implicit name (assuming they differ).Specific example (and initial use case is for support Kotlin's "is getter" matching (see Kotling Interop for details), in which field like '
isOpen
' would have implicit name of "isOpen", match gettergetOpen()
and settersetOpen(boolean)
, but use logical external name of "isOpen" (and not implicit name of getter/setter, "open"!). To achieve this, field implicit name needs to remain "isOpen" but this method needs to return namePropertyName.construct("open")
: doing so will "pull in" getter and/or setter, and rename them as "isOpen".- Overrides:
findRenameByField
in classAnnotationIntrospector
- Parameters:
config
- Effective mapper configuration in usef
- Field to checkimplName
- Implicit name of the field; usually name of field itself but not always, used as the target name for accessors to rename.- Returns:
- Name used to find other accessors to rename, if any;
null
to indicate no renaming
-
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 toAnnotationIntrospector.findSubtypes(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.Annotated)
- Overrides:
findTypeResolver
in classAnnotationIntrospector
- Parameters:
config
- Configuration settings in effect (for serialization or deserialization)ac
- Annotated class to check for annotationsbaseType
- 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 toAnnotationIntrospector.findSubtypes(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.Annotated)
- Overrides:
findPropertyTypeResolver
in classAnnotationIntrospector
- Parameters:
config
- Configuration settings in effect (for serialization or deserialization)am
- Annotated member (field or method) to check for annotationsbaseType
- 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 toAnnotationIntrospector.findSubtypes(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.Annotated)
- Overrides:
findPropertyContentTypeResolver
in classAnnotationIntrospector
- Parameters:
config
- Configuration settings in effect (for serialization or deserialization)am
- Annotated member (field or method) to check for annotationscontainerType
- 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
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 classAnnotationIntrospector
- Parameters:
a
- Annotated entity (class, field/method) to check for annotations- Returns:
- List of subtype definitions found if any;
null
if none
-
findTypeName
Description copied from class:AnnotationIntrospector
Method for checking if specified type has explicit name.- Overrides:
findTypeName
in classAnnotationIntrospector
- Parameters:
ac
- Class to check for type name annotations- Returns:
- Explicit type name (aka Type Id) found, if any;
null
if none
-
isTypeId
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 classAnnotationIntrospector
- Parameters:
member
- Annotated accessor (field/method/constructor parameter) to check for annotations- Returns:
- Boolean to indicate whether member is a type id or not, if annotation
found;
null
if no information found.
-
findObjectIdInfo
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 classAnnotationIntrospector
- Parameters:
ann
- Annotated entity to introspect- Returns:
- Details of Object Id as explained above, if Object Id
handling to be applied;
null
otherwise.
-
findObjectReferenceInfo
Description copied from class:AnnotationIntrospector
Method for figuring out additional properties of an Object Identity reference- Overrides:
findObjectReferenceInfo
in classAnnotationIntrospector
- Parameters:
ann
- Annotated entity to introspectobjectIdInfo
- (optional) Base Object Id information, if any;null
if none- Returns:
ObjectIdInfo
augmented with possible additional information
-
findSerializer
Description copied from class:AnnotationIntrospector
Method for getting a serializer definition on specified method or field. Type of definition is either instance (of typeJsonSerializer
) or Class (ofClass<JsonSerializer>
implementation subtype); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findSerializer
in classAnnotationIntrospector
-
findKeySerializer
Description copied from class:AnnotationIntrospector
Method for getting a serializer definition for keys of associatedjava.util.Map
property. Type of definition is either instance (of typeJsonSerializer
) or Class (of typeClass<JsonSerializer>
); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findKeySerializer
in classAnnotationIntrospector
-
findContentSerializer
Description copied from class:AnnotationIntrospector
Method for getting a serializer definition for content (values) of associatedCollection
,array
orMap
property. Type of definition is either instance (of typeJsonSerializer
) or Class (of typeClass<JsonSerializer>
); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findContentSerializer
in classAnnotationIntrospector
-
findNullSerializer
Description copied from class:AnnotationIntrospector
Method for getting a serializer definition for serializer to use for nulls (null values) of associated property or type.- Overrides:
findNullSerializer
in classAnnotationIntrospector
-
findPropertyInclusion
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 classAnnotationIntrospector
-
findSerializationTyping
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 classAnnotationIntrospector
- Returns:
- Typing mode to use, if annotation is found; null otherwise
-
findSerializationConverter
Description copied from class:AnnotationIntrospector
Method for findingConverter
that annotated entity (property or class) has indicated to be used as part of serialization. If not null, either has to be actualConverter
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 classAnnotationIntrospector
- Parameters:
a
- Annotated property (field, method) or class to check for annotations
-
findSerializationContentConverter
Description copied from class:AnnotationIntrospector
Method for findingConverter
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(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.Annotated)
- Overrides:
findSerializationContentConverter
in classAnnotationIntrospector
- Parameters:
a
- Annotated property (field, method) to check.
-
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, including not just value itself but key and/or content type, if type has those.- Overrides:
refineSerializationType
in classAnnotationIntrospector
- Throws:
JsonMappingException
-
findSerializationType
Deprecated.- Overrides:
findSerializationType
in classAnnotationIntrospector
-
findSerializationKeyType
Deprecated.- Overrides:
findSerializationKeyType
in classAnnotationIntrospector
-
findSerializationContentType
Deprecated.- Overrides:
findSerializationContentType
in classAnnotationIntrospector
-
findSerializationPropertyOrder
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 classAnnotationIntrospector
-
findSerializationSortAlphabetically
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 classAnnotationIntrospector
-
findAndAddVirtualProperties
public void findAndAddVirtualProperties(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties) Description copied from class:AnnotationIntrospector
Method for adding possible virtual properties to be serialized along with regular properties.- Overrides:
findAndAddVirtualProperties
in classAnnotationIntrospector
-
_constructVirtualProperty
protected BeanPropertyWriter _constructVirtualProperty(JsonAppend.Attr attr, MapperConfig<?> config, AnnotatedClass ac, JavaType type) -
_constructVirtualProperty
protected BeanPropertyWriter _constructVirtualProperty(JsonAppend.Prop prop, MapperConfig<?> config, AnnotatedClass ac) -
findNameForSerialization
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 (possiblyPropertyName.USE_DEFAULT
, which means "use default heuristics").- Overrides:
findNameForSerialization
in classAnnotationIntrospector
- Parameters:
a
- Property accessor to check- Returns:
- Name to use if found; null if not.
-
hasAsKey
Description copied from class:AnnotationIntrospector
Method for checking whether given method has an annotation that suggests the return value of annotated field or method should be used as "the key" of the object instance; usually serialized as a primitive value such as String or number.- Overrides:
hasAsKey
in classAnnotationIntrospector
- Returns:
Boolean.TRUE
if such annotation is found and is not disabled;Boolean.FALSE
if disabled annotation (block) is found (to indicate accessor is definitely NOT to be used "as value"); or `null` if no information found.
-
hasAsValue
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:
hasAsValue
in classAnnotationIntrospector
- Returns:
Boolean.TRUE
if such annotation is found and is not disabled;Boolean.FALSE
if disabled annotation (block) is found (to indicate accessor is definitely NOT to be used "as value"); or `null` if no information found.
-
hasAnyGetter
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:
hasAnyGetter
in classAnnotationIntrospector
- Parameters:
a
- Annotated entity to check- Returns:
- True if such annotation is found (and is not disabled), false otherwise
-
hasAnyGetterAnnotation
Deprecated.- Overrides:
hasAnyGetterAnnotation
in classAnnotationIntrospector
- Parameters:
am
- Annotated method to check
-
hasAsValueAnnotation
Deprecated.- Overrides:
hasAsValueAnnotation
in classAnnotationIntrospector
- Parameters:
am
- Annotated method to check
-
findDeserializer
Description copied from class:AnnotationIntrospector
Method for getting a deserializer definition on specified method or field. Type of definition is either instance (of typeJsonDeserializer
) or Class (of typeClass&<JsonDeserializer>
); type is returned, a runtime exception may be thrown by caller.- Overrides:
findDeserializer
in classAnnotationIntrospector
-
findKeyDeserializer
Description copied from class:AnnotationIntrospector
Method for getting a deserializer definition for keys of associatedMap
property. Type of definition is either instance (of typeJsonDeserializer
) or Class (of typeClass<JsonDeserializer>
); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findKeyDeserializer
in classAnnotationIntrospector
-
findContentDeserializer
Description copied from class:AnnotationIntrospector
Method for getting a deserializer definition for content (values) of associatedCollection
,array
orMap
property. Type of definition is either instance (of typeJsonDeserializer
) or Class (of typeClass<JsonDeserializer>
); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findContentDeserializer
in classAnnotationIntrospector
-
findDeserializationConverter
Description copied from class:AnnotationIntrospector
Method for findingConverter
that annotated entity (property or class) has indicated to be used as part of deserialization. If not null, either has to be actualConverter
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 classAnnotationIntrospector
- Parameters:
a
- Annotated property (field, method) or class to check for annotations
-
findDeserializationContentConverter
Description copied from class:AnnotationIntrospector
Method for findingConverter
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(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.Annotated)
- Overrides:
findDeserializationContentConverter
in classAnnotationIntrospector
- Parameters:
a
- Annotated property (field, method) to check.
-
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 classAnnotationIntrospector
- Throws:
JsonMappingException
-
findDeserializationContentType
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 classAnnotationIntrospector
- Parameters:
am
- Annotated entity to introspectbaseContentType
- 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
-
findDeserializationType
Deprecated.Description copied from class:AnnotationIntrospector
Method for accessing annotated type definition that a property can have, to be used as the type for deserialization instead of the static (declared) type. Type is usually narrowing conversion (i.e.subtype of declared type). Declared return type of the method is also considered acceptable.- Overrides:
findDeserializationType
in classAnnotationIntrospector
- Parameters:
am
- Annotated entity to introspectbaseType
- Assumed type before considering annotations- Returns:
- Class to use for deserialization instead of declared type
-
findDeserializationKeyType
Deprecated.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 withMap
types.- Overrides:
findDeserializationKeyType
in classAnnotationIntrospector
- Parameters:
am
- Annotated entity to introspectbaseKeyType
- Assumed key type before considering annotations- Returns:
- Class specifying more specific type to use instead of declared type, if annotation found; null if not
-
findValueInstantiator
Description copied from class:AnnotationIntrospector
Method gettingValueInstantiator
to use for given type (class): return value can either be an instance of instantiator, or class of instantiator to create.- Overrides:
findValueInstantiator
in classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspect- Returns:
- Either
ValueInstantiator
instance to use, orClass
of one to create; ornull
if no annotations found to indicate custom value instantiator.
-
findPOJOBuilder
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 classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspect- Returns:
- Builder class to use, if annotation found;
null
if not.
-
findPOJOBuilderConfig
- Overrides:
findPOJOBuilderConfig
in classAnnotationIntrospector
- Parameters:
ac
- Annotated class to introspect- Returns:
- Builder settings to use, if any found;
null
if not.
-
findNameForDeserialization
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 (possiblyPropertyName.USE_DEFAULT
, which means "use default heuristics").- Overrides:
findNameForDeserialization
in classAnnotationIntrospector
- Parameters:
a
- Annotated entity to check- Returns:
- Name to use if found;
null
if not.
-
hasAnySetter
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:
hasAnySetter
in classAnnotationIntrospector
- Parameters:
a
- Annotated entity to check- Returns:
Boolean.TRUE
orBoolean.FALSE
if explicit "any setter" marker found;null
otherwise.
-
findSetterInfo
Description copied from class:AnnotationIntrospector
Method for finding possible settings for property, given annotations on an accessor.- Overrides:
findSetterInfo
in classAnnotationIntrospector
- Parameters:
a
- Annotated entity to check- Returns:
- Setter info value found, if any;
JsonSetter.Value.empty()
if none (should not returnnull
)
-
findMergeInfo
Description copied from class:AnnotationIntrospector
Method for finding merge settings for property, if any.- Overrides:
findMergeInfo
in classAnnotationIntrospector
- Parameters:
a
- Annotated entity to check- Returns:
Boolean.TRUE
orBoolean.FALSE
if explicit merge enable/disable found;null
otherwise.
-
hasAnySetterAnnotation
Deprecated.- Overrides:
hasAnySetterAnnotation
in classAnnotationIntrospector
- Parameters:
am
- Annotated method to check- Returns:
true
if "any-setter" annotation was found;false
otherwise
-
hasCreatorAnnotation
Deprecated.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 classAnnotationIntrospector
- Parameters:
a
- Annotated entity to check- Returns:
- True if such annotation is found (and is not disabled), false otherwise
-
findCreatorBinding
Deprecated.Description copied from class:AnnotationIntrospector
Method for finding indication of creator binding mode for a creator (something for whichAnnotationIntrospector.hasCreatorAnnotation(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.Annotated)
returns true), for cases where there may be ambiguity (currently: single-argument creator with implicit but no explicit name for the argument).- Overrides:
findCreatorBinding
in classAnnotationIntrospector
- Parameters:
a
- Annotated entity to check- Returns:
- Creator mode found, if any;
null
if none
-
findCreatorAnnotation
Description copied from class:AnnotationIntrospector
Method called to check whether potential Creator (constructor or static factory method) has explicit annotation to indicate it as actual Creator; and if so, whichJsonCreator.Mode
to use.NOTE: caller needs to consider possibility of both `null` (no annotation found) and
JsonCreator.Mode.DISABLED
(annotation found, but disabled); latter is necessary as marker in case multiple introspectors are chained, as well as possibly as when using mix-in annotations.- Overrides:
findCreatorAnnotation
in classAnnotationIntrospector
- Parameters:
config
- Configuration settings in effect (for serialization or deserialization)a
- Annotated accessor (usually constructor or static method) to check- Returns:
- Creator mode found, if any;
null
if none
-
_isIgnorable
-
_classIfExplicit
-
_classIfExplicit
-
_propertyName
-
_findConstructorName
-
_findTypeResolver
protected TypeResolverBuilder<?> _findTypeResolver(MapperConfig<?> config, Annotated ann, JavaType baseType) Helper method called to construct and initialize instance ofTypeResolverBuilder
if given annotated element indicates one is needed. -
_constructStdTypeResolverBuilder
Helper method for constructing standardTypeResolverBuilder
implementation. -
_constructNoTypeResolverBuilder
Helper method for dealing with "no type info" marker; can't be null (as it'd be replaced by default typing)
-