Package org.codehaus.jackson.map.introspect

Class NopAnnotationIntrospector

  • public class NopAnnotationIntrospector
extends AnnotationIntrospector
    Dummy, "no-operation" implementation of AnnotationIntrospector. Can be used as is to suppress handling of annotations; or as a basis for simple complementary annotators

    • Field Detail

      • instance

        public static final NopAnnotationIntrospector instance
        Static immutable and shareable instance that can be used as "null" introspector: one that never finds any annotation information.

    • Constructor Detail

      • NopAnnotationIntrospector

        public NopAnnotationIntrospector()

    • Method Detail

      • isHandled

        public boolean isHandled​(java.lang.annotation.Annotation ann)
        Description copied from class: AnnotationIntrospector
        Method called by framework to determine whether given annotation is handled by this introspector.
        Specified by:
        isHandled in class AnnotationIntrospector

      • findEnumValue

        public java.lang.String findEnumValue​(java.lang.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).

        NOTE: implemented since 1.9.11, to make things work even when annotation introspection is disabled.

        Overrides:
        findEnumValue in class AnnotationIntrospector
        Returns:
        Serialized enum value.

      • findRootName

        public java.lang.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.
        Specified by:
        findRootName in class AnnotationIntrospector

      • findPropertiesToIgnore

        public java.lang.String[] findPropertiesToIgnore​(AnnotatedClass 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.
        Specified by:
        findPropertiesToIgnore in class AnnotationIntrospector

      • isIgnorableMethod

        public boolean isIgnorableMethod​(AnnotatedMethod m)
        Description copied from class: AnnotationIntrospector
        Method for checking whether there is an annotation that indicates that given method should be ignored for all operations (serialization, deserialization).

        Note that this method should ONLY return true for such explicit ignoral cases; and not if method just happens not to be visible for annotation processor.

        Specified by:
        isIgnorableMethod in class AnnotationIntrospector
        Returns:
        True, if an annotation is found to indicate that the method should be ignored; false if not.

      • isIgnorableField

        public boolean isIgnorableField​(AnnotatedField f)
        Description copied from class: AnnotationIntrospector
        Method for checking whether there is an annotation that indicates that given field should be ignored for all operations (serialization, deserialization).
        Specified by:
        isIgnorableField in class AnnotationIntrospector
        Returns:
        True, if an annotation is found to indicate that the field should be ignored; false if not.

      • findSerializer

        public java.lang.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.

        Note: this variant was briefly deprecated for 1.7; should not be

        Specified by:
        findSerializer in class AnnotationIntrospector

      • findSerializationType

        public java.lang.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.
        Specified by:
        findSerializationType in class AnnotationIntrospector
        Returns:
        Class to use instead of runtime type

      • 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.
        Specified by:
        findSerializationTyping in class AnnotationIntrospector
        Returns:
        Typing mode to use, if annotation is found; null otherwise

      • findSerializationViews

        public java.lang.Class<?>[] findSerializationViews​(Annotated a)
        Description copied from class: AnnotationIntrospector
        Method for checking if annotated serializable property (represented by field or getter method) has definitions for views it is to be included in. If null is returned, no view definitions exist and property is always included; 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)
        Specified by:
        findSerializationViews in class AnnotationIntrospector
        Parameters:
        a - Annotated serializable property (field or getter method)
        Returns:
        Array of views (represented by classes) that the property is included in; if null, always included (same as returning array containing Object.class)

      • findGettablePropertyName

        public java.lang.String findGettablePropertyName​(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".
        Specified by:
        findGettablePropertyName 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.
        Specified by:
        hasAsValueAnnotation in class AnnotationIntrospector
        Returns:
        True if such annotation is found (and is not disabled); false if no enabled annotation is found

      • findDeserializablePropertyName

        public java.lang.String findDeserializablePropertyName​(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".
        Specified by:
        findDeserializablePropertyName in class AnnotationIntrospector

      • findDeserializationContentType

        public java.lang.Class<?> findDeserializationContentType​(Annotated am,
                                                         JavaType t,
                                                         java.lang.String propName)
        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.
        Specified by:
        findDeserializationContentType in class AnnotationIntrospector
        t - Assumed content (value) type before considering annotations
        propName - Logical property name of the property that uses type, if known; null for types not associated with property
        Returns:
        Class specifying more specific type to use instead of declared type, if annotation found; null if not

      • findDeserializationKeyType

        public java.lang.Class<?> findDeserializationKeyType​(Annotated am,
                                                     JavaType t,
                                                     java.lang.String propName)
        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.
        Specified by:
        findDeserializationKeyType in class AnnotationIntrospector
        t - Assumed key type before considering annotations
        propName - Logical property name of the property that uses type, if known; null for types not associated with property
        Returns:
        Class specifying more specific type to use instead of declared type, if annotation found; null if not

      • findDeserializationType

        public java.lang.Class<?> findDeserializationType​(Annotated am,
                                                  JavaType t,
                                                  java.lang.String propName)
        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.
        Specified by:
        findDeserializationType in class AnnotationIntrospector
        t - Assumed type before considering annotations
        propName - Logical property name of the property that uses type, if known; null for types not associated with property
        Returns:
        Class to use for deserialization instead of declared type

      • findDeserializer

        public java.lang.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.

        Note: this variant was briefly deprecated for 1.7; but it turns out we really should not try to push BeanProperty through at this point

        Specified by:
        findDeserializer in class AnnotationIntrospector

      • findPropertyNameForParam

        public java.lang.String findPropertyNameForParam​(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.
        Specified by:
        findPropertyNameForParam in class AnnotationIntrospector

      • findSerializablePropertyName

        public java.lang.String findSerializablePropertyName​(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".
        Specified by:
        findSerializablePropertyName in class AnnotationIntrospector

      • findSettablePropertyName

        public java.lang.String findSettablePropertyName​(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".
        Specified by:
        findSettablePropertyName in class AnnotationIntrospector