Module tools.jackson.databind

Package tools.jackson.databind.introspect

Class AnnotatedField

java.lang.Object

tools.jackson.databind.introspect.Annotated

tools.jackson.databind.introspect.AnnotatedMember

tools.jackson.databind.introspect.AnnotatedField

public final class AnnotatedField
extends AnnotatedMember

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final Field	_field	Actual Field used for access.

Fields inherited from class tools.jackson.databind.introspect.AnnotatedMember

_annotations, _typeContext

Constructor Summary

Constructors

Constructor	Description
AnnotatedField(TypeResolutionContext contextClass, Field field, AnnotationMap annMap)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Field	getAnnotated()	Method that can be used to find actual JDK element that this instance represents.
int	getAnnotationCount()
Class<?>	getDeclaringClass()	Actual physical class in which this member was declared.
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.
JavaType	getType()	Full generic type 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 tools.jackson.databind.introspect.AnnotatedMember

_annotationMap, annotations, fixAccess, getAnnotation, getFullName, hasAnnotation, hasOneOf

Methods inherited from class tools.jackson.databind.introspect.Annotated

isPublic, isStatic

Methods inherited from class java.lang.Object

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

Field Details

_field

protected final Field _field

Actual Field used for access.

Constructor Details

AnnotatedField

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

Method Details

withAnnotations

public AnnotatedField withAnnotations(AnnotationMap ann)

Description copied from class: AnnotatedMember

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

Specified by:

withAnnotations in class AnnotatedMember

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

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

getType

public JavaType getType()

Description copied from class: Annotated

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

Specified by:

getType in class Annotated

getDeclaringClass

public Class<?> getDeclaringClass()

Description copied from class: AnnotatedMember

Actual physical class in which this member was declared.

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

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