Jandex: Core 3.1.6 · org.jboss.jandex.FieldInfo

Modifier and Type	Field and Description
private ClassInfo	clazz
private FieldInternal	internal

Access	Constructor and Description
pack-priv	FieldInfo()
pack-priv	FieldInfo(ClassInfo clazz, FieldInternal internal)
pack-priv	FieldInfo(ClassInfo clazz, byte[] name, Type type, short flags)

Method Summary

Modifier and Type	Method and Description
public final AnnotationInstance	Returns: the annotation instance, or `null` if not found annotation(DotName name of the annotation type to look for, must not be `null` name) Implements org.jboss.jandex.AnnotationTarget.annotation. Returns the annotation instance with given name declared on this field or any type within its signature.
public final List<AnnotationInstance>	Returns: immutable list of annotation instances, never `null` annotations(DotName name of the annotation type, must not be `null` name) Implements org.jboss.jandex.AnnotationTarget.annotations. Returns the annotation instances with given name declared on this field or any type within its signature.
public final List<AnnotationInstance>	Returns: collection of annotation instances, never `null` annotations() Implements org.jboss.jandex.AnnotationTarget.annotations. Returns the annotation instances declared on this field or any type within its signature.
public final List<AnnotationInstance>	Returns: immutable list of annotation instances, never `null` annotationsWithRepeatable(DotName name of the annotation type, must not be `null` name, IndexView index used to obtain the annotation type, must not be `null` index) Implements org.jboss.jandex.AnnotationTarget.annotationsWithRepeatable. Returns the annotation instances with given name declared on this field or any type within its signature.
public final ClassInfo	asClass() Implements org.jboss.jandex.AnnotationTarget.asClass. Casts and returns this target as a `ClassInfo` if it is of kind `CLASS`
public final FieldInfo	asField() Implements org.jboss.jandex.AnnotationTarget.asField. Casts and returns this target as a `FieldInfo` if it is of kind `FIELD`
public final MethodInfo	asMethod() Implements org.jboss.jandex.AnnotationTarget.asMethod. Casts and returns this target as a `MethodInfo` if it is of kind `METHOD`
public final MethodParameterInfo	asMethodParameter() Implements org.jboss.jandex.AnnotationTarget.asMethodParameter. Casts and returns this target as a `MethodParameterInfo` if it is of kind `METHOD_PARAMETER`
public final RecordComponentInfo	asRecordComponent() Implements org.jboss.jandex.AnnotationTarget.asRecordComponent. Casts and returns this target as a `RecordComponentInfo` if it is of kind `RECORD_COMPONENT`
public final TypeTarget	asType() Implements org.jboss.jandex.AnnotationTarget.asType. Casts and returns this target as a `TypeTarget` if it is of kind `TYPE`
public static FieldInfo	Returns: a mock field create(ClassInfo the class declaring the field clazz, String the name of the field name, Type the Java field type type, short the field attributes flags) Construct a new mock Field instance.
public final AnnotationInstance	Returns: the annotation instance, or `null` if not found declaredAnnotation(DotName name of the annotation type to look for, must not be `null` name) Implements org.jboss.jandex.AnnotationTarget.declaredAnnotation. Returns the annotation instance with given name declared on this field.
public final List<AnnotationInstance>	Returns: list of annotation instances, never `null` declaredAnnotations() Implements org.jboss.jandex.AnnotationTarget.declaredAnnotations. Returns the annotation instances declared on this field.
public final List<AnnotationInstance>	Returns: list of annotation instances, never `null` declaredAnnotationsWithRepeatable(DotName name of the annotation type, must not be `null` name, IndexView index used to obtain the annotation type, must not be `null` index) Implements org.jboss.jandex.AnnotationTarget.declaredAnnotationsWithRepeatable. Returns the annotation instances with given name declared on this field.
public final ClassInfo	Returns: the declaring class declaringClass() Returns the class which declared the field
public String	Returns: the bytecode descriptor of this field descriptor(Function<String, Type> a substitution function from type variable identifiers to types typeVariableSubstitution) Implements org.jboss.jandex.Descriptor.descriptor. Returns a bytecode descriptor of this field.
public int	Returns: ordinal of this enum constant, or -1 if this field is not an enum constant enumConstantOrdinal() Returns an ordinal of this enum constant, that is, the zero-based position in the enum declaration.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
pack-priv FieldInternal	fieldInternal()
public final short	Returns: the access flags of this field flags() Returns the access fields of this field.
public String	Returns: a generic signature of this field with type variables substituted, never `null` genericSignature(Function<String, Type> a substitution function from type variable identifiers to types typeVariableSubstitution) Implements org.jboss.jandex.GenericSignature.genericSignature. Returns a generic signature of this field, possibly without any generic-related information.
public final boolean	Returns: `true` if the annotation is present, `false` otherwise hasAnnotation(DotName name of the annotation type to look for, must not be `null` name) Implements org.jboss.jandex.AnnotationTarget.hasAnnotation. Returns whether an annotation instance with given name is declared on this field or any type within its signature.
public final boolean	Returns: `true` if the annotation is present, `false` otherwise hasDeclaredAnnotation(DotName name of the annotation type to look for, must not be `null` name) Implements org.jboss.jandex.AnnotationTarget.hasDeclaredAnnotation. Returns whether an annotation instance with given name is declared on this field.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public final boolean	Returns: true if the field is declared as an element of an enum, false otherwise isEnumConstant() Returns whether this field is declared as an element of an enum.
public final boolean	Returns: `true` if this field is a synthetic field isSynthetic()
public final AnnotationTarget.Kind	kind() Implements org.jboss.jandex.AnnotationTarget.kind. Returns the kind of object this target represents.
public final String	Returns: the local name of the field name() Returns the local name of the field
public boolean	Returns: whether this field must have a generic signature requiresGenericSignature() Implements org.jboss.jandex.GenericSignature.requiresGenericSignature. Returns whether this field must have a generic signature.
pack-priv void	setAnnotations(List<AnnotationInstance> annotations)
pack-priv void	setClassInfo(ClassInfo clazz)
pack-priv void	setFieldInternal(FieldInternal internal)
pack-priv void	setType(Type type)
public String	Returns: a string representation of this field toString() Overrides java.lang.Object.toString. Returns a string representation describing this field.
public final Type	Returns: the type of this field type() Returns the `Type` declared on this field.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

clazz	back to summary
private ClassInfo clazz

internal	back to summary
private FieldInternal internal

FieldInfo	back to summary
pack-priv FieldInfo()

FieldInfo	back to summary
pack-priv FieldInfo(ClassInfo clazz, FieldInternal internal)

FieldInfo	back to summary
pack-priv FieldInfo(ClassInfo clazz, byte[] name, Type type, short flags)

Method Detail

annotation back to summary

annotation	back to summary
public final AnnotationInstance annotation(DotName name) Implements org.jboss.jandex.AnnotationTarget.annotation. Returns the annotation instance with given name declared on this field or any type within its signature. The `target()` method of the returned annotation instance may be used to determine the exact location of the annotation instance. The following is a non-exhaustive list of examples of annotations returned by this method: @MyFieldAnnotation public String foo; public List<@MyTypeAnnotation String> bar; In case an annotation with given name occurs more than once, the result of this method is not deterministic. For such situations, `annotations(DotName)` is preferable. Parameters name:DotName name of the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found See Also `annotations(DotName)`

public final AnnotationInstance annotation(DotName name)

Implements org.jboss.jandex.AnnotationTarget.annotation.

Returns the annotation instance with given name declared on this field or any type within its signature. The target() method of the returned annotation instance may be used to determine the exact location of the annotation instance.

The following is a non-exhaustive list of examples of annotations returned by this method:

@MyFieldAnnotation
public String foo;

public List<@MyTypeAnnotation String> bar;

In case an annotation with given name occurs more than once, the result of this method is not deterministic. For such situations, annotations(DotName) is preferable.

Parameters

name:DotName: name of the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

See Also

annotations(DotName)

annotations back to summary

annotations	back to summary
public final List<AnnotationInstance> annotations(DotName name) Implements org.jboss.jandex.AnnotationTarget.annotations. Returns the annotation instances with given name declared on this field or any type within its signature. The `target()` method of the returned annotation instances may be used to determine the exact location of the respective annotation instance. The following is a non-exhaustive list of examples of annotations returned by this method: @MyFieldAnnotation public String foo; public List<@MyTypeAnnotation String> bar; Parameters name:DotName name of the annotation type, must not be `null` Returns:List<AnnotationInstance> immutable list of annotation instances, never `null` Annotations @Override See Also `annotationsWithRepeatable(DotName, IndexView)`, `annotations()`

public final List<AnnotationInstance> annotations(DotName name)

Implements org.jboss.jandex.AnnotationTarget.annotations.

Returns the annotation instances with given name declared on this field or any type within its signature. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.

The following is a non-exhaustive list of examples of annotations returned by this method:

@MyFieldAnnotation
public String foo;

public List<@MyTypeAnnotation String> bar;

Parameters

name:DotName: name of the annotation type, must not be null

Returns:List<AnnotationInstance>

immutable list of annotation instances, never null

Annotations

@Override

annotations back to summary

annotations	back to summary
public final List<AnnotationInstance> annotations() Implements org.jboss.jandex.AnnotationTarget.annotations. Returns the annotation instances declared on this field or any type within its signature. The `target()` method of the returned annotation instances may be used to determine the exact location of the respective annotation instance. The following is a non-exhaustive list of examples of annotations returned by this method: @MyFieldAnnotation public String foo; public List<@MyTypeAnnotation String> bar; Returns:List<AnnotationInstance> collection of annotation instances, never `null`

public final List<AnnotationInstance> annotations()

Implements org.jboss.jandex.AnnotationTarget.annotations.

Returns the annotation instances declared on this field or any type within its signature. The target() method of the returned annotation instances may be used to determine the exact location of the respective annotation instance.

The following is a non-exhaustive list of examples of annotations returned by this method:

@MyFieldAnnotation
public String foo;

public List<@MyTypeAnnotation String> bar;

Returns:List<AnnotationInstance>: collection of annotation instances, never null

annotationsWithRepeatable back to summary

annotationsWithRepeatable	back to summary
public final List<AnnotationInstance> annotationsWithRepeatable(DotName name, IndexView index) Implements org.jboss.jandex.AnnotationTarget.annotationsWithRepeatable. Returns the annotation instances with given name declared on this field or any type within its signature. The `target()` method of the returned annotation instances may be used to determine the exact location of the respective annotation instance. If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the `AnnotationInstance#target()` returns the target of the container annotation instance. Parameters name:DotName name of the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:List<AnnotationInstance> immutable list of annotation instances, never `null` Exceptions IllegalArgumentException: if the index is `null`, if the index does not contain the annotation type or if `name` does not identify an annotation type See Also `annotations(DotName)`, `annotations()`

public final List<AnnotationInstance> annotationsWithRepeatable(DotName name, IndexView index)

Implements org.jboss.jandex.AnnotationTarget.annotationsWithRepeatable.

If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the AnnotationInstance#target() returns the target of the container annotation instance.

Parameters

name:DotName: name of the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:List<AnnotationInstance>

immutable list of annotation instances, never null

Exceptions

IllegalArgumentException:: if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type

See Also

annotations(DotName), annotations()

asClass back to summary

asClass	back to summary
public final ClassInfo asClass() Implements org.jboss.jandex.AnnotationTarget.asClass. Doc from org.jboss.jandex.AnnotationTarget.asClass. Casts and returns this target as a `ClassInfo` if it is of kind `CLASS` Returns:ClassInfo this instance cast to a class Annotations @Override

public final ClassInfo asClass()

Implements org.jboss.jandex.AnnotationTarget.asClass.

Doc from org.jboss.jandex.AnnotationTarget.asClass.

Casts and returns this target as a ClassInfo if it is of kind CLASS

Returns:ClassInfo

this instance cast to a class

Annotations

@Override

asField back to summary

asField	back to summary
public final FieldInfo asField() Implements org.jboss.jandex.AnnotationTarget.asField. Doc from org.jboss.jandex.AnnotationTarget.asField. Casts and returns this target as a `FieldInfo` if it is of kind `FIELD` Returns:FieldInfo this instance cast to a field Annotations @Override

public final FieldInfo asField()

Implements org.jboss.jandex.AnnotationTarget.asField.

Doc from org.jboss.jandex.AnnotationTarget.asField.

Casts and returns this target as a FieldInfo if it is of kind FIELD

Returns:FieldInfo

this instance cast to a field

Annotations

@Override

asMethod back to summary

asMethod	back to summary
public final MethodInfo asMethod() Implements org.jboss.jandex.AnnotationTarget.asMethod. Doc from org.jboss.jandex.AnnotationTarget.asMethod. Casts and returns this target as a `MethodInfo` if it is of kind `METHOD` Returns:MethodInfo this instance cast to a method Annotations @Override

public final MethodInfo asMethod()

Implements org.jboss.jandex.AnnotationTarget.asMethod.

Doc from org.jboss.jandex.AnnotationTarget.asMethod.

Casts and returns this target as a MethodInfo if it is of kind METHOD

Returns:MethodInfo

this instance cast to a method

Annotations

@Override

asMethodParameter back to summary

asMethodParameter	back to summary
public final MethodParameterInfo asMethodParameter() Implements org.jboss.jandex.AnnotationTarget.asMethodParameter. Doc from org.jboss.jandex.AnnotationTarget.asMethodParameter. Casts and returns this target as a `MethodParameterInfo` if it is of kind `METHOD_PARAMETER` Returns:MethodParameterInfo this instance cast to a method parameter Annotations @Override

public final MethodParameterInfo asMethodParameter()

Implements org.jboss.jandex.AnnotationTarget.asMethodParameter.

Doc from org.jboss.jandex.AnnotationTarget.asMethodParameter.

Casts and returns this target as a MethodParameterInfo if it is of kind METHOD_PARAMETER

Returns:MethodParameterInfo

this instance cast to a method parameter

Annotations

@Override

asRecordComponent back to summary

asRecordComponent	back to summary
public final RecordComponentInfo asRecordComponent() Implements org.jboss.jandex.AnnotationTarget.asRecordComponent. Doc from org.jboss.jandex.AnnotationTarget.asRecordComponent. Casts and returns this target as a `RecordComponentInfo` if it is of kind `RECORD_COMPONENT` Returns:RecordComponentInfo this instance cast to a record component Annotations @Override

public final RecordComponentInfo asRecordComponent()

Implements org.jboss.jandex.AnnotationTarget.asRecordComponent.

Doc from org.jboss.jandex.AnnotationTarget.asRecordComponent.

Casts and returns this target as a RecordComponentInfo if it is of kind RECORD_COMPONENT

Returns:RecordComponentInfo

this instance cast to a record component

Annotations

@Override

asType back to summary

asType	back to summary
public final TypeTarget asType() Implements org.jboss.jandex.AnnotationTarget.asType. Doc from org.jboss.jandex.AnnotationTarget.asType. Casts and returns this target as a `TypeTarget` if it is of kind `TYPE` Returns:TypeTarget this instance cast to a type target Annotations @Override

public final TypeTarget asType()

Implements org.jboss.jandex.AnnotationTarget.asType.

Doc from org.jboss.jandex.AnnotationTarget.asType.

Casts and returns this target as a TypeTarget if it is of kind TYPE

Returns:TypeTarget

this instance cast to a type target

Annotations

@Override

create	back to summary
public static FieldInfo create(ClassInfo clazz, String name, Type type, short flags) Construct a new mock Field instance. Parameters clazz:ClassInfo the class declaring the field name:String the name of the field type:Type the Java field type flags:short the field attributes Returns:FieldInfo a mock field

create

back to summary

public static FieldInfo create(ClassInfo clazz, String name, Type type, short flags)

Construct a new mock Field instance.

Parameters

clazz:ClassInfo: the class declaring the field
name:String: the name of the field
type:Type: the Java field type
flags:short: the field attributes

Returns:FieldInfo

a mock field

declaredAnnotation back to summary

declaredAnnotation	back to summary
public final AnnotationInstance declaredAnnotation(DotName name) Implements org.jboss.jandex.AnnotationTarget.declaredAnnotation. Returns the annotation instance with given name declared on this field. Unlike `annotation(DotName)`, this method doesn't return annotations declared on types within the field signature. Parameters name:DotName name of the annotation type to look for, must not be `null` Returns:AnnotationInstance the annotation instance, or `null` if not found Annotations @Override Since 3.0 See Also `annotation(DotName)`

public final AnnotationInstance declaredAnnotation(DotName name)

Implements org.jboss.jandex.AnnotationTarget.declaredAnnotation.

Returns the annotation instance with given name declared on this field.

Unlike annotation(DotName), this method doesn't return annotations declared on types within the field signature.

Parameters

name:DotName: name of the annotation type to look for, must not be null

Returns:AnnotationInstance

the annotation instance, or null if not found

Annotations

@Override

Since

3.0

See Also

annotation(DotName)

declaredAnnotations back to summary

declaredAnnotations	back to summary
public final List<AnnotationInstance> declaredAnnotations() Implements org.jboss.jandex.AnnotationTarget.declaredAnnotations. Returns the annotation instances declared on this field. Unlike `annotations()`, this method doesn't return annotations declared on types within the field signature. Returns:List<AnnotationInstance> list of annotation instances, never `null` Annotations @Override Since 3.0 See Also `annotations()`

public final List<AnnotationInstance> declaredAnnotations()

Implements org.jboss.jandex.AnnotationTarget.declaredAnnotations.

Returns the annotation instances declared on this field.

Unlike annotations(), this method doesn't return annotations declared on types within the field signature.

Returns:List<AnnotationInstance>

list of annotation instances, never null

Annotations

@Override

Since

3.0

See Also

annotations()

declaredAnnotationsWithRepeatable back to summary

declaredAnnotationsWithRepeatable	back to summary
public final List<AnnotationInstance> declaredAnnotationsWithRepeatable(DotName name, IndexView index) Implements org.jboss.jandex.AnnotationTarget.declaredAnnotationsWithRepeatable. Returns the annotation instances with given name declared on this field. If the specified annotation is repeatable, the result also contains all values from the container annotation instance. In this case, the `AnnotationInstance#target()` returns the target of the container annotation instance. Unlike `annotationsWithRepeatable(DotName, IndexView)`, this method doesn't return annotations declared on types within the field signature. Parameters name:DotName name of the annotation type, must not be `null` index:IndexView index used to obtain the annotation type, must not be `null` Returns:List<AnnotationInstance> list of annotation instances, never `null` Annotations @Override Exceptions IllegalArgumentException: if the index is `null`, if the index does not contain the annotation type or if `name` does not identify an annotation type Since 3.0 See Also `annotationsWithRepeatable(DotName, IndexView)`

public final List<AnnotationInstance> declaredAnnotationsWithRepeatable(DotName name, IndexView index)

Implements org.jboss.jandex.AnnotationTarget.declaredAnnotationsWithRepeatable.

Returns the annotation instances with given name declared on this field.

Unlike annotationsWithRepeatable(DotName, IndexView), this method doesn't return annotations declared on types within the field signature.

Parameters

name:DotName: name of the annotation type, must not be null
index:IndexView: index used to obtain the annotation type, must not be null

Returns:List<AnnotationInstance>

list of annotation instances, never null

Annotations

@Override

Exceptions

IllegalArgumentException:: if the index is null, if the index does not contain the annotation type or if name does not identify an annotation type

Since

3.0

declaringClass	back to summary
public final ClassInfo declaringClass() Returns the class which declared the field Returns:ClassInfo the declaring class

declaringClass

back to summary

public final ClassInfo declaringClass()

Returns the class which declared the field

Returns:ClassInfo: the declaring class

descriptor back to summary

descriptor	back to summary
public String descriptor(Function<String, Type> typeVariableSubstitution) Implements org.jboss.jandex.Descriptor.descriptor. Returns a bytecode descriptor of this field. Descriptors of type variables are substituted for descriptors of types provided by the substitution function `typeVariableSubstitution`. If the substitution function returns `null` for some type variable identifier, or if it returns the type variable itself, no substitution happens and the type variable descriptor is used unmodified. Note that the return value does not come directly from bytecode. Jandex does not store the descriptor strings. Instead, the return value is reconstructed from the Jandex object model. Parameters typeVariableSubstitution:Function<String, Type> Doc from org.jboss.jandex.Descriptor.descriptor. a substitution function from type variable identifiers to types Returns:String the bytecode descriptor of this field

public String descriptor(Function<String, Type> typeVariableSubstitution)

Implements org.jboss.jandex.Descriptor.descriptor.

Returns a bytecode descriptor of this field.

Descriptors of type variables are substituted for descriptors of types provided by the substitution function typeVariableSubstitution. If the substitution function returns null for some type variable identifier, or if it returns the type variable itself, no substitution happens and the type variable descriptor is used unmodified.

Note that the return value does not come directly from bytecode. Jandex does not store the descriptor strings. Instead, the return value is reconstructed from the Jandex object model.

Parameters

typeVariableSubstitution:Function<String, Type>

Doc from org.jboss.jandex.Descriptor.descriptor.

a substitution function from type variable identifiers to types

Returns:String

the bytecode descriptor of this field

enumConstantOrdinal	back to summary
public int enumConstantOrdinal() Returns an ordinal of this enum constant, that is, the zero-based position in the enum declaration. This is currently very inefficient (requires traversing fields of the declaring class), but may be improved in the future. If this field is not an enum constant, returns -1. Note that for the result to actually be the ordinal value, the index must be produced by at least Jandex 2.4. Previous Jandex versions do not store field positions. At most 256 fields may be present in the class; if there's more, outcome is undefined. This also assumes that the bytecode order corresponds to declaration order, which is not guaranteed, but practically always holds. Returns:int ordinal of this enum constant, or -1 if this field is not an enum constant Since 3.0.1

enumConstantOrdinal

back to summary

public int enumConstantOrdinal()

Returns an ordinal of this enum constant, that is, the zero-based position in the enum declaration. This is currently very inefficient (requires traversing fields of the declaring class), but may be improved in the future.

If this field is not an enum constant, returns -1.

Note that for the result to actually be the ordinal value, the index must be produced by at least Jandex 2.4. Previous Jandex versions do not store field positions. At most 256 fields may be present in the class; if there's more, outcome is undefined. This also assumes that the bytecode order corresponds to declaration order, which is not guaranteed, but practically always holds.

Returns:int: ordinal of this enum constant, or -1 if this field is not an enum constant
Since: 3.0.1

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.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)

Overrides java.lang.Object.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

fieldInternal	back to summary
pack-priv FieldInternal fieldInternal()

flags back to summary

flags	back to summary
public final short flags() Returns the access fields of this field. `Modifier` can be used on this value. Returns:short the access flags of this field

public final short flags()

Returns the access fields of this field. Modifier can be used on this value.

Returns:short: the access flags of this field

genericSignature back to summary

genericSignature	back to summary
public String genericSignature(Function<String, Type> typeVariableSubstitution) Implements org.jboss.jandex.GenericSignature.genericSignature. Returns a generic signature of this field, possibly without any generic-related information. That is, produces a correct generic signature even if this field does not use any type variables. Signatures of type variables are substituted for signatures of types provided by the substitution function `typeVariableSubstitution`. If the substitution function returns `null` for some type variable identifier, no substitution happens and the type variable signature is used unmodified. Note that the return value does not come directly from bytecode. Jandex does not store the signature strings. Instead, the return value is reconstructed from the Jandex object model. Parameters typeVariableSubstitution:Function<String, Type> a substitution function from type variable identifiers to types Returns:String a generic signature of this field with type variables substituted, never `null` Annotations @Override

public String genericSignature(Function<String, Type> typeVariableSubstitution)

Implements org.jboss.jandex.GenericSignature.genericSignature.

Returns a generic signature of this field, possibly without any generic-related information. That is, produces a correct generic signature even if this field does not use any type variables.

Signatures of type variables are substituted for signatures of types provided by the substitution function typeVariableSubstitution. If the substitution function returns null for some type variable identifier, no substitution happens and the type variable signature is used unmodified.

Note that the return value does not come directly from bytecode. Jandex does not store the signature strings. Instead, the return value is reconstructed from the Jandex object model.

Parameters

typeVariableSubstitution:Function<String, Type>: a substitution function from type variable identifiers to types

Returns:String

a generic signature of this field with type variables substituted, never null

Annotations

@Override

hasAnnotation back to summary

hasAnnotation	back to summary
public final boolean hasAnnotation(DotName name) Implements org.jboss.jandex.AnnotationTarget.hasAnnotation. Returns whether an annotation instance with given name is declared on this field or any type within its signature. Parameters name:DotName name of the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise See Also `annotation(DotName)`

public final boolean hasAnnotation(DotName name)

Implements org.jboss.jandex.AnnotationTarget.hasAnnotation.

Returns whether an annotation instance with given name is declared on this field or any type within its signature.

Parameters

name:DotName: name of the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

See Also

annotation(DotName)

hasDeclaredAnnotation back to summary

hasDeclaredAnnotation	back to summary
public final boolean hasDeclaredAnnotation(DotName name) Implements org.jboss.jandex.AnnotationTarget.hasDeclaredAnnotation. Returns whether an annotation instance with given name is declared on this field. Unlike `hasAnnotation(DotName)`, this method ignores annotations declared on types within the field signature. Parameters name:DotName name of the annotation type to look for, must not be `null` Returns:boolean `true` if the annotation is present, `false` otherwise Annotations @Override Since 3.0 See Also `hasAnnotation(DotName)`

public final boolean hasDeclaredAnnotation(DotName name)

Implements org.jboss.jandex.AnnotationTarget.hasDeclaredAnnotation.

Returns whether an annotation instance with given name is declared on this field.

Unlike hasAnnotation(DotName), this method ignores annotations declared on types within the field signature.

Parameters

name:DotName: name of the annotation type to look for, must not be null

Returns:boolean

true if the annotation is present, false otherwise

Annotations

@Override

Since

3.0

See Also

hasAnnotation(DotName)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.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()

Overrides java.lang.Object.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

isEnumConstant back to summary

isEnumConstant	back to summary
public final boolean isEnumConstant() Returns whether this field is declared as an element of an enum. Returns:boolean true if the field is declared as an element of an enum, false otherwise See Also `java.lang.reflect.Field#isEnumConstant()`

public final boolean isEnumConstant()

Returns whether this field is declared as an element of an enum.

Returns:boolean: true if the field is declared as an element of an enum, false otherwise
See Also: java.lang.reflect.Field#isEnumConstant()

isSynthetic	back to summary
public final boolean isSynthetic() Returns:boolean `true` if this field is a synthetic field

kind	back to summary
public final AnnotationTarget.Kind kind() Implements org.jboss.jandex.AnnotationTarget.kind. Doc from org.jboss.jandex.AnnotationTarget.kind. Returns the kind of object this target represents. Returns:AnnotationTarget.Kind the target kind.

kind

back to summary

public final AnnotationTarget.Kind kind()

Implements org.jboss.jandex.AnnotationTarget.kind.

Doc from org.jboss.jandex.AnnotationTarget.kind.

Returns the kind of object this target represents.

Returns:AnnotationTarget.Kind: the target kind.

name	back to summary
public final String name() Returns the local name of the field Returns:String the local name of the field

name

back to summary

public final String name()

Returns the local name of the field

Returns:String: the local name of the field

requiresGenericSignature back to summary

requiresGenericSignature	back to summary
public boolean requiresGenericSignature() Implements org.jboss.jandex.GenericSignature.requiresGenericSignature. Returns whether this field must have a generic signature. That is, whether the Java compiler when compiling this field had to emit the `Signature` bytecode attribute. Returns:boolean whether this field must have a generic signature Annotations @Override

public boolean requiresGenericSignature()

Implements org.jboss.jandex.GenericSignature.requiresGenericSignature.

Returns whether this field must have a generic signature. That is, whether the Java compiler when compiling this field had to emit the Signature bytecode attribute.

Returns:boolean

whether this field must have a generic signature

Annotations

@Override

setAnnotations	back to summary
pack-priv void setAnnotations(List<AnnotationInstance> annotations)

setClassInfo	back to summary
pack-priv void setClassInfo(ClassInfo clazz)

setFieldInternal	back to summary
pack-priv void setFieldInternal(FieldInternal internal)

setType	back to summary
pack-priv void setType(Type type)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation describing this field. It is similar although not necessarily identical to a Java source code declaration of this field. Returns:String a string representation of this field

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation describing this field. It is similar although not necessarily identical to a Java source code declaration of this field.

Returns:String: a string representation of this field

type back to summary

type	back to summary
public final Type type() Returns the `Type` declared on this field. This may be an array, a primitive, or a generic type definition. Returns:Type the type of this field

public final Type type()

Returns the Type declared on this field. This may be an array, a primitive, or a generic type definition.

Returns:Type: the type of this field

public final Class FieldInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail