com.fasterxml.jackson.databind.introspect

Class AnnotatedField

java.lang.Object

com.fasterxml.jackson.databind.introspect.Annotated

com.fasterxml.jackson.databind.introspect.AnnotatedMember

com.fasterxml.jackson.databind.introspect.AnnotatedField

All Implemented Interfaces:

Serializable

public final class AnnotatedField
extends AnnotatedMember
implements Serializable

Object that represents non-static (and usually non-transient/volatile) fields of a class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Field	_field Actual Field used for access.
protected com.fasterxml.jackson.databind.introspect.AnnotatedField.Serialization	_serialization Temporary field required for JDK serialization support

Fields inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember

_annotations, _context

Constructor Summary

Constructors

Modifier	Constructor and Description
	AnnotatedField(AnnotatedClass contextClass, Field field, AnnotationMap annMap)
protected	AnnotatedField(com.fasterxml.jackson.databind.introspect.AnnotatedField.Serialization ser) Method used for JDK serialization support

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Field	getAnnotated() Method that can be used to find actual JDK element that this instance represents.
<A extends Annotation> A	getAnnotation(Class<A> acls)
int	getAnnotationCount()
Class<?>	getDeclaringClass() Actual physical class in which this memmber was declared.
String	getFullName()
Type	getGenericType() Full generic type of the annotated element; definition of what exactly this means depends on sub-class.
Member	getMember()
int	getModifiers()
String	getName()
Class<?>	getRawType() "Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.
Object	getValue(Object pojo) Optional method that can be used to access the value of this member on given object, if this is a supported operation for member type.
int	hashCode()
boolean	isTransient()
void	setValue(Object pojo, Object value) Optional method that can be used to assign value of this member on given object, if this is a supported operation for member type.
String	toString()
AnnotatedField	withAnnotations(AnnotationMap ann) Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.

Methods inherited from class com.fasterxml.jackson.databind.introspect.AnnotatedMember

addIfNotPresent, addOrOverride, annotations, fixAccess, getAllAnnotations, getContextClass

Methods inherited from class com.fasterxml.jackson.databind.introspect.Annotated

getType, hasAnnotation, isPublic, withFallBackAnnotationsFrom

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_field

protected final transient Field _field

Actual Field used for access.

Transient since it can not be persisted directly using JDK serialization

_serialization

protected com.fasterxml.jackson.databind.introspect.AnnotatedField.Serialization _serialization

Temporary field required for JDK serialization support

Constructor Detail

AnnotatedField

public AnnotatedField(AnnotatedClass contextClass,
                      Field field,
                      AnnotationMap annMap)

AnnotatedField

protected AnnotatedField(com.fasterxml.jackson.databind.introspect.AnnotatedField.Serialization ser)

Method used for JDK serialization support

Method Detail

withAnnotations

public AnnotatedField withAnnotations(AnnotationMap ann)

Description copied from class: Annotated

Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.

Specified by:

withAnnotations in class Annotated

getAnnotated

public Field getAnnotated()

Description copied from class: Annotated

Method that can be used to find actual JDK element that this instance represents. It is non-null, except for method/constructor parameters which do not have a JDK counterpart.

Specified by:

getAnnotated in class Annotated

getModifiers

public int getModifiers()

Specified by:

getModifiers in class Annotated

getName

public String getName()

Specified by:

getName in class Annotated

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> acls)

Specified by:

getAnnotation in class Annotated

getGenericType

public Type getGenericType()

Description copied from class: Annotated

Full generic type of the annotated element; definition of what exactly this means depends on sub-class.

Specified by:

getGenericType in class Annotated

getRawType

public Class<?> getRawType()

Description copied from class: Annotated

"Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.

Specified by:

getRawType in class Annotated

getDeclaringClass

public Class<?> getDeclaringClass()

Description copied from class: AnnotatedMember

Actual physical class in which this memmber was declared. Note that this may be different from what AnnotatedMember.getContextClass() returns; "owner" may be a sub-type of "declaring class".

Specified by:

getDeclaringClass in class AnnotatedMember

getMember

public Member getMember()

Specified by:

getMember in class AnnotatedMember

setValue

public void setValue(Object pojo,
                     Object value)
              throws IllegalArgumentException

Description copied from class: AnnotatedMember

Optional method that can be used to assign value of this member on given object, if this is a supported operation for member type.

This is implemented for fields and single-argument member methods; but not for constructor parameters or other types of methods (like static methods)

Specified by:

setValue in class AnnotatedMember

Throws:

IllegalArgumentException

getValue

public Object getValue(Object pojo)
                throws IllegalArgumentException

Description copied from class: AnnotatedMember

Optional method that can be used to access the value of this member on given object, if this is a supported operation for member type.

This is implemented for fields and no-argument member methods; but not for constructor parameters or other types of methods (like static methods)

Specified by:

getValue in class AnnotatedMember

Throws:

IllegalArgumentException

getFullName

public String getFullName()

getAnnotationCount

public int getAnnotationCount()

isTransient

public boolean isTransient()

Since:

2.6

hashCode

public int hashCode()

Specified by:

hashCode in class Annotated

equals

public boolean equals(Object o)

Specified by:

equals in class Annotated

toString

public String toString()

Specified by:

toString in class Annotated