Top Description Fields Constructors Methods
tools.jackson.databind.introspect

public abstract Class AnnotatedMember

extends Annotated
Class Inheritance
Known Direct Subclasses
tools.jackson.databind.introspect.AnnotatedParameter, tools.jackson.databind.introspect.AnnotatedWithParams, tools.jackson.databind.introspect.VirtualAnnotatedMember, tools.jackson.databind.introspect.AnnotatedField
Imports
java.lang.annotation.Annotation, java.lang.reflect.Member, java.util.stream.Stream, tools.jackson.databind.util.ClassUtil

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

Modifier and TypeField and Description
protected final AnnotationMap
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

AccessConstructor and Description
protected
protected
AnnotatedMember(AnnotatedMember base)

Copy-constructor.

Method Summary

Modifier and TypeMethod and Description
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.

public Stream<Annotation>
public final void
fixAccess(boolean force)

Method that can be called to modify access rights, by calling java.lang.reflect.AccessibleObject#setAccessible on the underlying annotated element.

public final <A extends Annotation> A
public abstract Class<?>
getDeclaringClass()

Actual physical class in which this member was declared.

public String
public abstract Member
public 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.

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

Implements abstract tools.jackson.databind.introspect.Annotated.hasOneOf.

public 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.

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.

Inherited from tools.jackson.databind.introspect.Annotated:
equalsgetAnnotatedgetModifiersgetNamegetRawTypegetTypehashCodeisPublicisStatictoString

Field Detail

_annotationsback to summary
protected final AnnotationMap _annotations
_typeContextback to summary
protected final TypeResolutionContext _typeContext

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

Constructor Detail

AnnotatedMemberback to summary
protected AnnotatedMember(TypeResolutionContext ctxt, AnnotationMap annotations)
AnnotatedMemberback to summary
protected AnnotatedMember(AnnotatedMember base)

Copy-constructor.

Method Detail

_annotationMapback to summary
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).

Annotations
@Deprecated
annotationsback to summary
public Stream<Annotation> annotations()

Implements abstract tools.jackson.databind.introspect.Annotated.annotations.

Annotations
@Override
fixAccessback to summary
public final void fixAccess(boolean force)

Method that can be called to modify access rights, by calling java.lang.reflect.AccessibleObject#setAccessible on the underlying annotated element.

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

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

Implements abstract tools.jackson.databind.introspect.Annotated.getAnnotation.

Annotations
@Override
getDeclaringClassback to summary
public abstract Class<?> getDeclaringClass()

Actual physical class in which this member was declared.

getFullNameback to summary
public String getFullName()
getMemberback to summary
public abstract Member getMember()
getValueback to summary
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)

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

Implements abstract tools.jackson.databind.introspect.Annotated.hasAnnotation.

Annotations
@Override
hasOneOfback to summary
public boolean hasOneOf(Class<? extends Annotation>[] annoClasses)

Implements abstract tools.jackson.databind.introspect.Annotated.hasOneOf.

Annotations
@Override
setValueback to summary
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)

withAnnotationsback to summary
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.