Class AccessorNamingStrategy

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      abstract java.lang.String findNameForIsGetter​(AnnotatedMethod method, 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)
      abstract java.lang.String findNameForMutator​(AnnotatedMethod method, 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)
      abstract java.lang.String findNameForRegularGetter​(AnnotatedMethod method, 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)
      abstract 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
    • Constructor Detail

      • AccessorNamingStrategy

        public AccessorNamingStrategy()
    • Method Detail

      • findNameForIsGetter

        public abstract java.lang.String findNameForIsGetter​(AnnotatedMethod method,
                                                             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)

        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.

        Parameters:
        method - 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 abstract java.lang.String findNameForRegularGetter​(AnnotatedMethod method,
                                                                  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)

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

        Parameters:
        method - 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 abstract java.lang.String findNameForMutator​(AnnotatedMethod method,
                                                            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)

        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.

        Parameters:
        method - 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 abstract 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.

        Note that visibility checks are applied separately; strategy does not need to be concerned with that aspect.

        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)