org.codehaus.jackson.map.introspect

类 NopAnnotationIntrospector

java.lang.Object

org.codehaus.jackson.map.AnnotationIntrospector

org.codehaus.jackson.map.introspect.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

嵌套类概要

从类继承的嵌套类/接口 org.codehaus.jackson.map.AnnotationIntrospector

AnnotationIntrospector.Pair, AnnotationIntrospector.ReferenceProperty

字段概要

字段

限定符和类型	字段和说明
static NopAnnotationIntrospector	instance Static immutable and shareable instance that can be used as "null" introspector: one that never finds any annotation information.

构造器概要

构造器

构造器和说明
NopAnnotationIntrospector()

方法概要

方法

限定符和类型	方法和说明
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) 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) Method for getting a serializer definition on specified method or field.
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	hasIgnoreMarker(AnnotatedMember member) Method called to check whether given property is marked to be ignored; but NOT to determine if it should necessarily be ignored, since that may depend on other factors.
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).

从类继承的方法 org.codehaus.jackson.map.AnnotationIntrospector

allIntrospectors, allIntrospectors, findAutoDetectVisibility, findCachability, findContentSerializer, findFilterId, findInjectableValueId, findKeySerializer, findPropertyContentTypeResolver, findPropertyTypeResolver, findReferenceType, findSerializationContentType, findSerializationInclusion, findSerializationKeyType, findSubtypes, findTypeName, findTypeResolver, findValueInstantiator, hasAnyGetterAnnotation, hasAnySetterAnnotation, hasCreatorAnnotation, isIgnorableType, nopInstance, pair, shouldUnwrapProperty

从类继承的方法 java.lang.Object

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

字段详细资料

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.

构造器详细资料

NopAnnotationIntrospector

public NopAnnotationIntrospector()

方法详细资料

isHandled

public boolean isHandled(Annotation ann)

从类复制的说明: AnnotationIntrospector

Method called by framework to determine whether given annotation is handled by this introspector.

指定者:

isHandled 在类中 AnnotationIntrospector

findEnumValue

public String findEnumValue(Enum<?> value)

从类复制的说明: AnnotationIntrospector

Method for determining the String value to use for serializing given enumeration entry; used when serializing enumerations as Strings (the standard method).

指定者:

findEnumValue 在类中 AnnotationIntrospector

返回:

Serialized enum value.

findRootName

public String findRootName(AnnotatedClass ac)

从类复制的说明: 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.

指定者:

findRootName 在类中 AnnotationIntrospector

findPropertiesToIgnore

public String[] findPropertiesToIgnore(AnnotatedClass ac)

从类复制的说明: 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.

指定者:

findPropertiesToIgnore 在类中 AnnotationIntrospector

findIgnoreUnknownProperties

public Boolean findIgnoreUnknownProperties(AnnotatedClass ac)

从类复制的说明: AnnotationIntrospector

Method for checking whether an annotation indicates that all unknown properties

指定者:

findIgnoreUnknownProperties 在类中 AnnotationIntrospector

hasIgnoreMarker

public boolean hasIgnoreMarker(AnnotatedMember member)

从类复制的说明: AnnotationIntrospector

Method called to check whether given property is marked to be ignored; but NOT to determine if it should necessarily be ignored, since that may depend on other factors.

Default implementation calls existing 'isIgnored' methods such as AnnotationIntrospector.isIgnorableField(AnnotatedField) and AnnotationIntrospector.isIgnorableMethod(AnnotatedMethod).

覆盖:

hasIgnoreMarker 在类中 AnnotationIntrospector

isIgnorableConstructor

public boolean isIgnorableConstructor(AnnotatedConstructor c)

指定者:

isIgnorableConstructor 在类中 AnnotationIntrospector

isIgnorableMethod

public boolean isIgnorableMethod(AnnotatedMethod m)

从类复制的说明: 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.

指定者:

isIgnorableMethod 在类中 AnnotationIntrospector

返回:

True, if an annotation is found to indicate that the method should be ignored; false if not.

isIgnorableField

public boolean isIgnorableField(AnnotatedField f)

从类复制的说明: AnnotationIntrospector

Method for checking whether there is an annotation that indicates that given field should be ignored for all operations (serialization, deserialization).

指定者:

isIgnorableField 在类中 AnnotationIntrospector

返回:

True, if an annotation is found to indicate that the field should be ignored; false if not.

findSerializer

public Object findSerializer(Annotated am)

从类复制的说明: 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

指定者:

findSerializer 在类中 AnnotationIntrospector

findSerializationType

public Class<?> findSerializationType(Annotated a)

从类复制的说明: 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.

指定者:

findSerializationType 在类中 AnnotationIntrospector

返回:

Class to use instead of runtime type

findSerializationTyping

public JsonSerialize.Typing findSerializationTyping(Annotated a)

从类复制的说明: 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.

指定者:

findSerializationTyping 在类中 AnnotationIntrospector

返回:

Typing mode to use, if annotation is found; null otherwise

findSerializationViews

public Class<?>[] findSerializationViews(Annotated a)

从类复制的说明: 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)

指定者:

findSerializationViews 在类中 AnnotationIntrospector

参数:

a - Annotated serializable property (field or getter method)

返回:

Array of views (represented by classes) that the property is included in; if null, always included (same as returning array containing Object.class)

findSerializationPropertyOrder

public String[] findSerializationPropertyOrder(AnnotatedClass ac)

从类复制的说明: AnnotationIntrospector

Method for accessing defined property serialization order (which may be partial). May return null if no ordering is defined.

指定者:

findSerializationPropertyOrder 在类中 AnnotationIntrospector

findSerializationSortAlphabetically

public Boolean findSerializationSortAlphabetically(AnnotatedClass ac)

从类复制的说明: AnnotationIntrospector

Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) ordered

指定者:

findSerializationSortAlphabetically 在类中 AnnotationIntrospector

findGettablePropertyName

public String findGettablePropertyName(AnnotatedMethod am)

从类复制的说明: 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".

指定者:

findGettablePropertyName 在类中 AnnotationIntrospector

hasAsValueAnnotation

public boolean hasAsValueAnnotation(AnnotatedMethod am)

从类复制的说明: 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.

指定者:

hasAsValueAnnotation 在类中 AnnotationIntrospector

返回:

True if such annotation is found (and is not disabled); false if no enabled annotation is found

findDeserializablePropertyName

public String findDeserializablePropertyName(AnnotatedField af)

从类复制的说明: 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".

指定者:

findDeserializablePropertyName 在类中 AnnotationIntrospector

findDeserializationContentType

public Class<?> findDeserializationContentType(Annotated am,
                                      JavaType t,
                                      String propName)

从类复制的说明: 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.

指定者:

findDeserializationContentType 在类中 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

返回:

Class specifying more specific type to use instead of declared type, if annotation found; null if not

findDeserializationKeyType

public Class<?> findDeserializationKeyType(Annotated am,
                                  JavaType t,
                                  String propName)

从类复制的说明: 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.

指定者:

findDeserializationKeyType 在类中 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

返回:

Class specifying more specific type to use instead of declared type, if annotation found; null if not

findDeserializationType

public Class<?> findDeserializationType(Annotated am,
                               JavaType t,
                               String propName)

从类复制的说明: 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.

指定者:

findDeserializationType 在类中 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

返回:

Class to use for deserialization instead of declared type

findDeserializer

public Object findDeserializer(Annotated am)

从类复制的说明: 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

指定者:

findDeserializer 在类中 AnnotationIntrospector

findKeyDeserializer

public Class<KeyDeserializer> findKeyDeserializer(Annotated am)

从类复制的说明: AnnotationIntrospector

Method for getting a deserializer definition for keys of associated 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 在类中 AnnotationIntrospector

findContentDeserializer

public Class<JsonDeserializer<?>> findContentDeserializer(Annotated am)

从类复制的说明: AnnotationIntrospector

Method for getting a deserializer definition for content (values) of associated 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 在类中 AnnotationIntrospector

findPropertyNameForParam

public String findPropertyNameForParam(AnnotatedParameter param)

从类复制的说明: 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.

指定者:

findPropertyNameForParam 在类中 AnnotationIntrospector

findSerializablePropertyName

public String findSerializablePropertyName(AnnotatedField af)

从类复制的说明: 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".

指定者:

findSerializablePropertyName 在类中 AnnotationIntrospector

findSettablePropertyName

public String findSettablePropertyName(AnnotatedMethod am)

从类复制的说明: 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".

指定者:

findSettablePropertyName 在类中 AnnotationIntrospector