Class DefaultAccessorNamingStrategy
- Direct Known Subclasses:
DefaultAccessorNamingStrategy.RecordNaming
AccessorNamingStrategy
used by Jackson: to be used either as-is,
or as base-class with overrides.- Since:
- 2.12
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Definition of a handler API to use for checking whether given base name (remainder of accessor method name after removing prefix) is acceptable based on various rules.static class
Simple implementation ofDefaultAccessorNamingStrategy.BaseNameValidator
that checks the first character and nothing else.static class
Provider forDefaultAccessorNamingStrategy
.static class
Implementation used for supporting "non-prefix" naming convention of Java 14java.lang.Record
types, and in particular find default accessors for declared record fields.Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.AccessorNamingStrategy
AccessorNamingStrategy.Base
-
Field Summary
Modifier and TypeFieldDescriptionprotected final DefaultAccessorNamingStrategy.BaseNameValidator
Optional validator for checking that base nameprotected final MapperConfig<?>
protected final AnnotatedClass
protected final String
protected final String
protected final boolean
protected final String
Prefix used by auto-detected mutators ("setters"): usually "set", but differs for builder objects ("with" by default).protected final boolean
-
Constructor Summary
ModifierConstructorDescriptionprotected
DefaultAccessorNamingStrategy
(MapperConfig<?> config, AnnotatedClass forClass, String mutatorPrefix, String getterPrefix, String isGetterPrefix, DefaultAccessorNamingStrategy.BaseNameValidator baseNameValidator) -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
protected boolean
findNameForIsGetter
(AnnotatedMethod am, String name) Method called to find whether given method would be considered an "is-getter" getter method in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property)findNameForMutator
(AnnotatedMethod am, String name) Method called to find whether given method would be considered a "mutator" (usually setter, but for builders "with-method" or similar) in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property)findNameForRegularGetter
(AnnotatedMethod am, String name) Method called to find whether given method would be considered a "regular" getter method in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property)protected String
legacyManglePropertyName
(String basename, int offset) Method called to figure out name of the property, given corresponding suggested name based on a method or field name.modifyFieldName
(AnnotatedField field, String name) Method called to find the name of logical property that given field should be associated with, if any.protected String
stdManglePropertyName
(String basename, int offset)
-
Field Details
-
_config
-
_forClass
-
_baseNameValidator
Optional validator for checking that base name -
_stdBeanNaming
protected final boolean _stdBeanNaming -
_isGettersNonBoolean
protected final boolean _isGettersNonBoolean -
_getterPrefix
-
_isGetterPrefix
- Since:
- 2.14
-
_mutatorPrefix
Prefix used by auto-detected mutators ("setters"): usually "set", but differs for builder objects ("with" by default).
-
-
Constructor Details
-
DefaultAccessorNamingStrategy
protected DefaultAccessorNamingStrategy(MapperConfig<?> config, AnnotatedClass forClass, String mutatorPrefix, String getterPrefix, String isGetterPrefix, DefaultAccessorNamingStrategy.BaseNameValidator baseNameValidator)
-
-
Method Details
-
findNameForIsGetter
Description copied from class:AccessorNamingStrategy
Method called to find whether given method would be considered an "is-getter" getter method in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property)Note that signature acceptability has already been checked (no arguments, has return value) but NOT the specific limitation that return type should be of boolean type -- implementation should apply latter check, if so desired (some languages may use different criteria). It is also possible that some implementations allow different return types than boolean types.
Note that visibility checks are applied separately; strategy does not need to be concerned with that aspect.
- Specified by:
findNameForIsGetter
in classAccessorNamingStrategy
- Parameters:
am
- Method to checkname
- Name to check (usually same asAnnotatedMethod.getName()
- Returns:
- Implied property name for is-getter method, if match;
null
to indicate that the name does not conform to expected naming convention
-
findNameForRegularGetter
Description copied from class:AccessorNamingStrategy
Method called to find whether given method would be considered a "regular" getter method in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property)Note that signature acceptability has already been checked (no arguments, does have a return value) by caller.
Note that this method MAY be called for potential "is-getter" methods too (before
AccessorNamingStrategy.findNameForIsGetter(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.AnnotatedMethod, java.lang.String)
)Note that visibility checks are applied separately; strategy does not need to be concerned with that aspect.
- Specified by:
findNameForRegularGetter
in classAccessorNamingStrategy
- Parameters:
am
- Method to checkname
- Name to check (usually same asAnnotatedMethod.getName()
- Returns:
- Implied property name for getter method, if match;
null
to indicate that the name does not conform to expected naming convention
-
findNameForMutator
Description copied from class:AccessorNamingStrategy
Method called to find whether given method would be considered a "mutator" (usually setter, but for builders "with-method" or similar) in context of type introspected, and if so, what is the logical property it is associated with (which in turn suggest external name for property)Note that signature acceptability has already been checked (exactly one parameter) by caller.
Note that visibility checks are applied separately; strategy does not need to be concerned with that aspect.
- Specified by:
findNameForMutator
in classAccessorNamingStrategy
- Parameters:
am
- Method to checkname
- Name to check (usually same asAnnotatedMethod.getName()
- Returns:
- Implied property name for mutator method, if match;
null
to indicate that the name does not conform to expected naming convention
-
modifyFieldName
Description copied from class:AccessorNamingStrategy
Method called to find the name of logical property that given field should be associated with, if any.Note that visibility checks are applied separately; strategy does not need to be concerned with that aspect.
- Specified by:
modifyFieldName
in classAccessorNamingStrategy
- Parameters:
field
- Field to checkname
- Name to check (usually same asAnnotatedField.getName()
- Returns:
- Implied property name matching given field (often field name as-is) or
null
to indicate that the name does not conform to expected naming convention (and will not be considered for property access)
-
legacyManglePropertyName
Method called to figure out name of the property, given corresponding suggested name based on a method or field name.- Parameters:
basename
- Name of accessor/mutator method, not including prefix ("get"/"is"/"set")
-
stdManglePropertyName
-
_isCglibGetCallbacks
-
_isGroovyMetaClassGetter
-