Module tools.jackson.databind

Package tools.jackson.databind.introspect

Class AnnotatedMember

java.lang.Object

tools.jackson.databind.introspect.Annotated

tools.jackson.databind.introspect.AnnotatedMember

Direct Known Subclasses:

AnnotatedField, AnnotatedParameter, AnnotatedWithParams, VirtualAnnotatedMember

public abstract class AnnotatedMember
extends Annotated

Intermediate base class for annotated entities that are members of a class; fields, methods and constructors. This is a superset of things that can represent logical properties as it contains constructors in addition to fields and methods.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotationMap	_annotations
protected final TypeResolutionContext	_typeContext	Context object needed for resolving generic type associated with this member (method parameter or return value, or field type).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AnnotatedMember(AnnotatedMember base)	Copy-constructor.
protected	AnnotatedMember(TypeResolutionContext ctxt, AnnotationMap annotations)

Method Summary

Modifier and Type	Method	Description
AnnotationMap	_annotationMap()	Deprecated. Not to be used by code outside jackson-databind.
Stream<Annotation>	annotations()
final void	fixAccess(boolean force)	Method that can be called to modify access rights, by calling AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean) on the underlying annotated element.
final <A extends Annotation> A	getAnnotation(Class<A> acls)
abstract Class<?>	getDeclaringClass()	Actual physical class in which this member was declared.
String	getFullName()
abstract Member	getMember()
abstract 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.
final boolean	hasAnnotation(Class<? extends Annotation> acls)
boolean	hasOneOf(Class<? extends Annotation>[] annoClasses)
abstract 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.
abstract Annotated	withAnnotations(AnnotationMap fallback)	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.Annotated

equals, getAnnotated, getModifiers, getName, getRawType, getType, hashCode, isPublic, isStatic, toString

Methods inherited from class java.lang.Object

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

Field Details

_typeContext

protected final TypeResolutionContext _typeContext

Context object needed for resolving generic type associated with this member (method parameter or return value, or field type).

_annotations

protected final AnnotationMap _annotations

Constructor Details

AnnotatedMember

protected AnnotatedMember(TypeResolutionContext ctxt,
 AnnotationMap annotations)

AnnotatedMember

protected AnnotatedMember(AnnotatedMember base)

Copy-constructor.

Method Details

withAnnotations

public abstract Annotated withAnnotations(AnnotationMap fallback)

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

getDeclaringClass

public abstract Class<?> getDeclaringClass()

Actual physical class in which this member was declared.

getMember

public abstract Member getMember()

getFullName

public String getFullName()

getAnnotation

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

Specified by:

getAnnotation in class Annotated

hasAnnotation

public final boolean hasAnnotation(Class<? extends Annotation> acls)

Specified by:

hasAnnotation in class Annotated

hasOneOf

public boolean hasOneOf(Class<? extends Annotation>[] annoClasses)

Specified by:

hasOneOf in class Annotated

annotations

public Stream<Annotation> annotations()

Specified by:

annotations in class Annotated

fixAccess

public final void fixAccess(boolean force)

Method that can be called to modify access rights, by calling AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean) on the underlying annotated element.

Note that caller should verify that MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS is enabled before calling this method; as well as pass force flag appropriately.

setValue

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

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)

Throws:

UnsupportedOperationException

IllegalArgumentException

getValue

public abstract Object getValue(Object pojo)
                         throws UnsupportedOperationException,
IllegalArgumentException

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)

Throws:

UnsupportedOperationException

IllegalArgumentException

_annotationMap

@Deprecated
public AnnotationMap _annotationMap()

Deprecated.

Not to be used by code outside jackson-databind.

Internal method used by POJOProperiesCollector to merge annotations from this member with those from another member.

NOTE: NOT to be used by code outside jackson-databind (but has to be public to be accessible from POJOPropertiesCollector).