|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.map.AnnotationIntrospector
org.codehaus.jackson.map.introspect.NopAnnotationIntrospector
public class NopAnnotationIntrospector
Dummy, "no-operation" implementation of AnnotationIntrospector
.
Can be used as is to suppress handling of annotations; or as a basis
for simple complementary annotators
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.codehaus.jackson.map.AnnotationIntrospector |
---|
AnnotationIntrospector.Pair, AnnotationIntrospector.ReferenceProperty |
Field Summary | |
---|---|
static NopAnnotationIntrospector |
instance
Static immutable and shareable instance that can be used as "null" introspector: one that never finds any annotation information. |
Constructor Summary | |
---|---|
NopAnnotationIntrospector()
|
Method Summary | |
---|---|
Boolean |
findCachability(AnnotatedClass ac)
Method that checks whether specified class has annotations that indicate that it is (or is not) cachable. |
Class<JsonDeserializer<?>> |
findContentDeserializer(Annotated am)
Method for getting a deserializer definition for content (values) of associated Collection , array or
Map property. |
String |
findDeserializablePropertyName(AnnotatedField af)
Method for checking whether given member field represent a deserializable logical property; and if so, returns the name of that property. |
Class<?> |
findDeserializationContentType(Annotated am,
JavaType t,
String propName)
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. |
Class<?> |
findDeserializationKeyType(Annotated am,
JavaType t,
String propName)
Method for accessing additional narrowing type definition that a method can have, to define more specific key type to use. |
Class<?> |
findDeserializationType(Annotated am,
JavaType t,
String propName)
Method for accessing annotated type definition that a method can have, to be used as the type for serialization instead of the runtime type. |
Object |
findDeserializer(Annotated am,
BeanProperty property)
Method for getting a deserializer definition on specified method or field. |
String |
findEnumValue(Enum<?> value)
Method for determining the String value to use for serializing given enumeration entry; used when serializing enumerations as Strings (the standard method). |
String |
findGettablePropertyName(AnnotatedMethod am)
Method for checking whether given method has an annotation that suggests property name associated with method that may be a "getter". |
Boolean |
findIgnoreUnknownProperties(AnnotatedClass ac)
Method for checking whether an annotation indicates that all unknown properties |
Class<KeyDeserializer> |
findKeyDeserializer(Annotated am)
Method for getting a deserializer definition for keys of associated Map property. |
String[] |
findPropertiesToIgnore(AnnotatedClass ac)
Method for finding list of properties to ignore for given class (null is returned if not specified). |
String |
findPropertyNameForParam(AnnotatedParameter param)
Method for checking whether given set of annotations indicates property name for associated parameter. |
String |
findRootName(AnnotatedClass ac)
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. |
String |
findSerializablePropertyName(AnnotatedField af)
Method for checking whether given member field represent a serializable logical property; and if so, returns the name of that property. |
String[] |
findSerializationPropertyOrder(AnnotatedClass ac)
Method for accessing defined property serialization order (which may be partial). |
Boolean |
findSerializationSortAlphabetically(AnnotatedClass ac)
Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) ordered |
Class<?> |
findSerializationType(Annotated a)
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. |
JsonSerialize.Typing |
findSerializationTyping(Annotated a)
Method for accessing declared typing mode annotated (if any). |
Class<?>[] |
findSerializationViews(Annotated a)
Method for checking if annotated serializable property (represented by field or getter method) has definitions for views it is to be included in. |
Object |
findSerializer(Annotated am,
BeanProperty property)
|
String |
findSettablePropertyName(AnnotatedMethod am)
Method for checking whether given method has an annotation that suggests property name associated with method that may be a "setter". |
boolean |
hasAsValueAnnotation(AnnotatedMethod am)
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 |
isHandled(Annotation ann)
Method called by framework to determine whether given annotation is handled by this introspector. |
boolean |
isIgnorableConstructor(AnnotatedConstructor c)
|
boolean |
isIgnorableField(AnnotatedField f)
Method for checking whether there is an annotation that indicates that given field should be ignored for all operations (serialization, deserialization). |
boolean |
isIgnorableMethod(AnnotatedMethod m)
Method for checking whether there is an annotation that indicates that given method should be ignored for all operations (serialization, deserialization). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final NopAnnotationIntrospector instance
Constructor Detail |
---|
public NopAnnotationIntrospector()
Method Detail |
---|
public boolean isHandled(Annotation ann)
AnnotationIntrospector
isHandled
in class AnnotationIntrospector
public String findEnumValue(Enum<?> value)
AnnotationIntrospector
findEnumValue
in class AnnotationIntrospector
public Boolean findCachability(AnnotatedClass ac)
AnnotationIntrospector
Currently only used with deserializers, to determine whether provider should cache instances, and if no annotations are found, assumes non-cachable instances.
findCachability
in class AnnotationIntrospector
public String findRootName(AnnotatedClass ac)
AnnotationIntrospector
findRootName
in class AnnotationIntrospector
public String[] findPropertiesToIgnore(AnnotatedClass ac)
AnnotationIntrospector
findPropertiesToIgnore
in class AnnotationIntrospector
public Boolean findIgnoreUnknownProperties(AnnotatedClass ac)
AnnotationIntrospector
findIgnoreUnknownProperties
in class AnnotationIntrospector
public boolean isIgnorableConstructor(AnnotatedConstructor c)
isIgnorableConstructor
in class AnnotationIntrospector
public boolean isIgnorableMethod(AnnotatedMethod m)
AnnotationIntrospector
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.
isIgnorableMethod
in class AnnotationIntrospector
public boolean isIgnorableField(AnnotatedField f)
AnnotationIntrospector
isIgnorableField
in class AnnotationIntrospector
public Object findSerializer(Annotated am, BeanProperty property)
findSerializer
in class AnnotationIntrospector
public Class<?> findSerializationType(Annotated a)
AnnotationIntrospector
findSerializationType
in class AnnotationIntrospector
public JsonSerialize.Typing findSerializationTyping(Annotated a)
AnnotationIntrospector
findSerializationTyping
in class AnnotationIntrospector
public Class<?>[] findSerializationViews(Annotated a)
AnnotationIntrospector
findSerializationViews
in class AnnotationIntrospector
a
- Annotated serializable property (field or getter method)
Object.class
)public String[] findSerializationPropertyOrder(AnnotatedClass ac)
AnnotationIntrospector
findSerializationPropertyOrder
in class AnnotationIntrospector
public Boolean findSerializationSortAlphabetically(AnnotatedClass ac)
AnnotationIntrospector
findSerializationSortAlphabetically
in class AnnotationIntrospector
public String findGettablePropertyName(AnnotatedMethod am)
AnnotationIntrospector
findGettablePropertyName
in class AnnotationIntrospector
public boolean hasAsValueAnnotation(AnnotatedMethod am)
AnnotationIntrospector
hasAsValueAnnotation
in class AnnotationIntrospector
public String findDeserializablePropertyName(AnnotatedField af)
AnnotationIntrospector
findDeserializablePropertyName
in class AnnotationIntrospector
public Class<?> findDeserializationContentType(Annotated am, JavaType t, String propName)
AnnotationIntrospector
findDeserializationContentType
in class AnnotationIntrospector
t
- Assumed content (value) type before considering annotationspropName
- Logical property name of the property that uses
type, if known; null for types not associated with property
public Class<?> findDeserializationKeyType(Annotated am, JavaType t, String propName)
AnnotationIntrospector
Map
types.
findDeserializationKeyType
in class AnnotationIntrospector
t
- Assumed key type before considering annotationspropName
- Logical property name of the property that uses
type, if known; null for types not associated with property
public Class<?> findDeserializationType(Annotated am, JavaType t, String propName)
AnnotationIntrospector
findDeserializationType
in class AnnotationIntrospector
t
- Assumed type before considering annotationspropName
- Logical property name of the property that uses
type, if known; null for types not associated with property
public Object findDeserializer(Annotated am, BeanProperty property)
AnnotationIntrospector
JsonDeserializer
) or Class (of type
Class
); if value of different
type is returned, a runtime exception may be thrown by caller.
findDeserializer
in class AnnotationIntrospector
public Class<KeyDeserializer> findKeyDeserializer(Annotated am)
AnnotationIntrospector
Map
property.
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.
findKeyDeserializer
in class AnnotationIntrospector
public Class<JsonDeserializer<?>> findContentDeserializer(Annotated am)
AnnotationIntrospector
Collection
, array
or
Map
property.
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.
findContentDeserializer
in class AnnotationIntrospector
public String findPropertyNameForParam(AnnotatedParameter param)
AnnotationIntrospector
findPropertyNameForParam
in class AnnotationIntrospector
public String findSerializablePropertyName(AnnotatedField af)
AnnotationIntrospector
findSerializablePropertyName
in class AnnotationIntrospector
public String findSettablePropertyName(AnnotatedMethod am)
AnnotationIntrospector
findSettablePropertyName
in class AnnotationIntrospector
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |