com.fasterxml.jackson.databind.introspect

Class DefaultAccessorNamingStrategy

java.lang.Object

com.fasterxml.jackson.databind.introspect.AccessorNamingStrategy

com.fasterxml.jackson.databind.introspect.DefaultAccessorNamingStrategy

Direct Known Subclasses:

DefaultAccessorNamingStrategy.RecordNaming

public class DefaultAccessorNamingStrategy
extends AccessorNamingStrategy

Default AccessorNamingStrategy used by Jackson: to be used either as-is, or as base-class with overrides.

Since:

2.12

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DefaultAccessorNamingStrategy.BaseNameValidator 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	DefaultAccessorNamingStrategy.FirstCharBasedValidator Simple implementation of DefaultAccessorNamingStrategy.BaseNameValidator that checks the first character and nothing else.
static class	DefaultAccessorNamingStrategy.Provider Provider for DefaultAccessorNamingStrategy.
static class	DefaultAccessorNamingStrategy.RecordNaming Implementation used for supporting "non-prefix" naming convention of Java 14 java.lang.Record types, and in particular find default accessors for declared record fields.

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

AccessorNamingStrategy.Base

Method Summary

Modifier and Type	Method and Description
java.lang.String	findNameForIsGetter(AnnotatedMethod am, java.lang.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)
java.lang.String	findNameForMutator(AnnotatedMethod am, java.lang.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)
java.lang.String	findNameForRegularGetter(AnnotatedMethod am, java.lang.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)
java.lang.String	modifyFieldName(AnnotatedField field, java.lang.String name) Method called to find the name of logical property that given field should be associated with, if any.

Methods inherited from class java.lang.Object

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

Method Detail

findNameForIsGetter

public java.lang.String findNameForIsGetter(AnnotatedMethod am,
                                            java.lang.String name)

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 class AccessorNamingStrategy

Parameters:

am - Method to check

name - Name to check (usually same as AnnotatedMethod.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

public java.lang.String findNameForRegularGetter(AnnotatedMethod am,
                                                 java.lang.String name)

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(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 class AccessorNamingStrategy

Parameters:

am - Method to check

name - Name to check (usually same as AnnotatedMethod.getName()

Returns:

Implied property name for getter method, if match; null to indicate that the name does not conform to expected naming convention

findNameForMutator

public java.lang.String findNameForMutator(AnnotatedMethod am,
                                           java.lang.String name)

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 class AccessorNamingStrategy

Parameters:

am - Method to check

name - Name to check (usually same as AnnotatedMethod.getName()

Returns:

Implied property name for mutator method, if match; null to indicate that the name does not conform to expected naming convention

modifyFieldName

public java.lang.String modifyFieldName(AnnotatedField field,
                                        java.lang.String name)

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 class AccessorNamingStrategy

Parameters:

field - Field to check

name - Name to check (usually same as AnnotatedField.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)