jackson-databind 2.16.0 · com.fasterxml.jackson.databind.introspect.AnnotatedField

Modifier and Type	Class and Description
private static class	AnnotatedField.Serialization Helper class that is used as the workaround to persist Field references.

Modifier and Type	Field and Description
protected final transient Field	_field Actual `Field` used for access.
protected AnnotatedField.Serialization	_serialization Temporary field required for JDK serialization support
private static final long	serialVersionUID Hides com.fasterxml.jackson.databind.introspect.AnnotatedMember.serialVersionUID.

Access	Constructor and Description
public	AnnotatedField(TypeResolutionContext contextClass, Field field, AnnotationMap annMap)
protected	AnnotatedField(AnnotatedField.Serialization ser) Method used for JDK serialization support

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.equals. Indicates whether some other object is "equal to" this one.
public Field	getAnnotated() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated. Method that can be used to find actual JDK element that this instance represents.
public int	getAnnotationCount()
public Class<?>	getDeclaringClass() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass. Actual physical class in which this member was declared.
public Member	getMember() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getMember.
public int	getModifiers() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getModifiers.
public String	getName() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getName.
public Class<?>	getRawType() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getRawType. "Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class.
public JavaType	getType() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getType. Full generic type of the annotated element; definition of what exactly this means depends on sub-class.
public Object	getValue(Object pojo) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue. 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 int	hashCode() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.hashCode. Returns a hash code value for the object.
public boolean	isTransient()
pack-priv Object	readResolve()
public void	setValue(Object pojo, Object value) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue. 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 String	toString() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.toString. Returns a string representation of the object.
public AnnotatedField	withAnnotations(AnnotationMap ann) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations. Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones.
pack-priv Object	writeReplace()

Inherited from com.fasterxml.jackson.databind.introspect.AnnotatedMember:: annotations fixAccess getAllAnnotations getAnnotation getFullName getTypeContext hasAnnotation hasOneOf

_field	back to summary
protected final transient Field _field Actual `Field` used for access. Transient since it cannot be persisted directly using JDK serialization

_serialization	back to summary
protected AnnotatedField.Serialization _serialization Temporary field required for JDK serialization support

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.databind.introspect.AnnotatedMember.serialVersionUID.

AnnotatedField	back to summary
public AnnotatedField(TypeResolutionContext contextClass, Field field, AnnotationMap annMap)

AnnotatedField	back to summary
protected AnnotatedField(AnnotatedField.Serialization ser) Method used for JDK serialization support

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAnnotated	back to summary
public Field getAnnotated() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated. Doc from com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated. 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. Annotations @Override

getAnnotated

back to summary

public Field getAnnotated()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated.

Doc from com.fasterxml.jackson.databind.introspect.Annotated.getAnnotated.

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.

Annotations

@Override

getAnnotationCount	back to summary
public int getAnnotationCount()

getDeclaringClass	back to summary
public Class<?> getDeclaringClass() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass. Actual physical class in which this member was declared. Annotations @Override

getDeclaringClass

back to summary

public Class<?> getDeclaringClass()

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.getDeclaringClass.

Actual physical class in which this member was declared.

Annotations

@Override

getMember	back to summary
public Member getMember() Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getMember. Annotations @Override

getMember

back to summary

public Member getMember()

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getMember.

Annotations

@Override

getModifiers	back to summary
public int getModifiers() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getModifiers. Annotations @Override

getModifiers

back to summary

public int getModifiers()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getModifiers.

Annotations

@Override

getName	back to summary
public String getName() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getName. Annotations @Override

getName

back to summary

public String getName()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getName.

Annotations

@Override

getRawType	back to summary
public Class<?> getRawType() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getRawType. Doc from com.fasterxml.jackson.databind.introspect.Annotated.getRawType. "Raw" type (type-erased class) of the annotated element; definition of what exactly this means depends on sub-class. Annotations @Override

getRawType

back to summary

public Class<?> getRawType()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getRawType.

Doc from com.fasterxml.jackson.databind.introspect.Annotated.getRawType.

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

Annotations

@Override

getType	back to summary
public JavaType getType() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getType. Doc from com.fasterxml.jackson.databind.introspect.Annotated.getType. Full generic type of the annotated element; definition of what exactly this means depends on sub-class. Annotations @Override

getType

back to summary

public JavaType getType()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.getType.

Doc from com.fasterxml.jackson.databind.introspect.Annotated.getType.

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

Annotations

@Override

getValue	back to summary
public Object getValue(Object pojo) throws IllegalArgumentException Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue. 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) Annotations @Override

getValue

back to summary

public Object getValue(Object pojo) throws IllegalArgumentException

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.getValue.

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)

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

isTransient	back to summary
public boolean isTransient() Since 2.6

readResolve	back to summary
pack-priv Object readResolve()

setValue	back to summary
public void setValue(Object pojo, Object value) throws IllegalArgumentException Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue. 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) Annotations @Override

setValue

back to summary

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

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.setValue.

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)

Annotations

@Override

toString	back to summary
public String toString() Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Implements abstract com.fasterxml.jackson.databind.introspect.Annotated.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

withAnnotations	back to summary
public AnnotatedField withAnnotations(AnnotationMap ann) Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations. Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations. Fluent factory method that will construct a new instance that uses specified instance annotations instead of currently configured ones. Annotations @Override

withAnnotations

back to summary

public AnnotatedField withAnnotations(AnnotationMap ann)

Implements abstract com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations.

Doc from com.fasterxml.jackson.databind.introspect.AnnotatedMember.withAnnotations.

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

Annotations