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

Modifier and Type	Class and Description
pack-priv static class	AnnotationInstance.NameComparator

Modifier and Type	Field and Description
pack-priv static final AnnotationInstance[]	EMPTY_ARRAY
private final DotName	name
pack-priv static final AnnotationInstance.NameComparator	NAME_COMPARATOR
pack-priv static final DotName	RETENTION
private final boolean	runtimeVisible
private final AnnotationTarget	target
private final AnnotationValue[]	values

Access	Constructor and Description
private	AnnotationInstance(DotName name, AnnotationTarget target, AnnotationValue[] values, boolean runtimeVisible)

Method Summary

Modifier and Type	Method and Description
pack-priv static AnnotationInstance	binarySearch(AnnotationInstance[] annotations, DotName name)
public static AnnotationInstanceBuilder	Returns: a builder instance, never `null` builder(Class<? extends Annotation> the type of annotation whose instance will be created, must not be `null` annotationType) Creates a builder of annotation instances of given `annotationType`.
public static AnnotationInstanceBuilder	Returns: a builder instance, never `null` builder(ClassInfo the type of annotation whose instance will be created, must not be `null` annotationType) Creates a builder of annotation instances of given `annotationType`.
public static AnnotationInstanceBuilder	Returns: a builder instance, never `null` builder(DotName the type of annotation whose instance will be created, must not be `null` annotationType) Creates a builder of annotation instances of given `annotationType`.
public static AnnotationInstanceBuilder	Returns: a builder instance, never `null` builder(DotName the type of annotation whose instance will be created, must not be `null` annotationType, boolean whether the annotation type has the runtime retention runtimeVisible) Creates a builder of annotation instances of given `annotationType`.
pack-priv static AnnotationInstance	create(AnnotationInstance instance, AnnotationTarget target)
public static AnnotationInstance	Returns: the new mock Annotation Instance create(DotName the name of the annotation instance name, AnnotationTarget the thing the annotation is declared on target, AnnotationValue[] the members of this annotation instance values) Construct a new mock annotation instance.
public static AnnotationInstance	Returns: the new mock Annotation Instance create(DotName the name of the annotation instance name, boolean whether the annotation is visible at runtime via the reflection API visible, AnnotationTarget the thing the annotation is declared on target, AnnotationValue[] the members of this annotation instance values) Construct a new mock annotation instance.
public static AnnotationInstance	Returns: the new mock Annotation Instance create(DotName the name of the annotation instance name, AnnotationTarget the thing the annotation is declared on target, List<AnnotationValue> the members of this annotation instance values) Construct a new mock annotation instance.
public static AnnotationInstance	Returns: the new mock Annotation Instance create(DotName the name of the annotation instance name, boolean whether the annotation is visible at runtime via the reflection API visible, AnnotationTarget the thing the annotation is declared on target, List<AnnotationValue> the members of this annotation instance values) Construct a new mock annotation instance.
public AnnotationInstanceEquivalenceProxy	createEquivalenceProxy() Returns an equivalence proxy for this annotation instance.
public boolean	Returns: `true` if equal, `false` if not equals(Object the annotation instance to compare to o) Overrides java.lang.Object.equals. Returns whether this annotation instance is equal to another instance.
public int	Returns: hash code consistent with annotation equivalence equivalenceHashCode() Returns an equivalence hash code.
public boolean	Returns: `true` if equivalent, `false` if not equivalentTo(AnnotationInstance the annotation instance to compare to other) Returns whether this annotation instance is equivalent to the `other` annotation instance.
public int	Returns: the hash code of this object hashCode() Overrides java.lang.Object.hashCode. Returns a hash code representing this object.
public DotName	Returns: the name of this annotation name() The name of this annotation in DotName form.
public boolean	runtimeVisible() Returns true if this annotation uses RetentionPolicy.RUNTIME and is visible to runtime reflection.
public AnnotationTarget	Returns: the target this annotation instance refers to target() The program element that this annotation was declared on.
public String	Returns: a string representation for this object toString(boolean whether to provide a simpler string representation simple) Returns an optionally simplified string that represents this annotation instance.
public String	Returns: a simple string representation for this annotation instance toString() Overrides java.lang.Object.toString. Returns a string representation for this annotation instance.
public AnnotationValue	Returns: the annotation member with specified name, or `null` value(final String the name of the annotation member name) Returns the member of this annotation that has the specified name.
public AnnotationValue	Returns: the `value` member value() Returns the member that has the special default name `value`.
pack-priv AnnotationValue[]	valueArray()
public List<AnnotationValue>	Returns: immutable list of this annotation's members values() Returns an immutable list of all members of this annotation instance.
public List<AnnotationValue>	Returns: immutable list of this annotation's members valuesWithDefaults(IndexView index) Returns a list of all members of this annotation instance, including default values if defined.
public AnnotationValue	Returns: the annotation member with specified name, or `null` valueWithDefault(IndexView the index containing the defining annotation class index, String the name of the annotation member name) Returns the member of this annotation that has the specified name, accounting for its default value.
public AnnotationValue	Returns: the `value` annotation member, or `null` valueWithDefault(IndexView the index containing the defining annotation class index) Returns the member of this annotation that has special name `value`, accounting for its default value.

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

EMPTY_ARRAY	back to summary
pack-priv static final AnnotationInstance[] EMPTY_ARRAY

name	back to summary
private final DotName name

NAME_COMPARATOR	back to summary
pack-priv static final AnnotationInstance.NameComparator NAME_COMPARATOR

RETENTION	back to summary
pack-priv static final DotName RETENTION

runtimeVisible	back to summary
private final boolean runtimeVisible

target	back to summary
private final AnnotationTarget target

values	back to summary
private final AnnotationValue[] values

AnnotationInstance	back to summary
private AnnotationInstance(DotName name, AnnotationTarget target, AnnotationValue[] values, boolean runtimeVisible)

Method Detail

binarySearch	back to summary
pack-priv static AnnotationInstance binarySearch(AnnotationInstance[] annotations, DotName name)

builder back to summary

builder	back to summary
public static AnnotationInstanceBuilder builder(Class<? extends Annotation> annotationType) Creates a builder of annotation instances of given `annotationType`. This allows creating an `AnnotationInstance` in a nicer way than using any of the `create()` methods. Parameters annotationType:Class<? extends Annotation> the type of annotation whose instance will be created, must not be `null` Returns:AnnotationInstanceBuilder a builder instance, never `null`

public static AnnotationInstanceBuilder builder(Class<? extends Annotation> annotationType)

Creates a builder of annotation instances of given annotationType. This allows creating an AnnotationInstance in a nicer way than using any of the create() methods.

Parameters

annotationType:Class<? extends Annotation>: the type of annotation whose instance will be created, must not be null

Returns:AnnotationInstanceBuilder

a builder instance, never null

builder back to summary

builder	back to summary
public static AnnotationInstanceBuilder builder(ClassInfo annotationType) Creates a builder of annotation instances of given `annotationType`. This allows creating an `AnnotationInstance` in a nicer way than using any of the `create()` methods. Parameters annotationType:ClassInfo the type of annotation whose instance will be created, must not be `null` Returns:AnnotationInstanceBuilder a builder instance, never `null`

public static AnnotationInstanceBuilder builder(ClassInfo annotationType)

Creates a builder of annotation instances of given annotationType. This allows creating an AnnotationInstance in a nicer way than using any of the create() methods.

Parameters

annotationType:ClassInfo: the type of annotation whose instance will be created, must not be null

Returns:AnnotationInstanceBuilder

a builder instance, never null

builder back to summary

builder	back to summary
public static AnnotationInstanceBuilder builder(DotName annotationType) Creates a builder of annotation instances of given `annotationType`. This allows creating an `AnnotationInstance` in a nicer way than using any of the `create()` methods. The given `annotationType` is assumed to have the runtime retention. Parameters annotationType:DotName the type of annotation whose instance will be created, must not be `null` Returns:AnnotationInstanceBuilder a builder instance, never `null`

public static AnnotationInstanceBuilder builder(DotName annotationType)

Creates a builder of annotation instances of given annotationType. This allows creating an AnnotationInstance in a nicer way than using any of the create() methods.

The given annotationType is assumed to have the runtime retention.

Parameters

annotationType:DotName: the type of annotation whose instance will be created, must not be null

Returns:AnnotationInstanceBuilder

a builder instance, never null

builder back to summary

builder	back to summary
public static AnnotationInstanceBuilder builder(DotName annotationType, boolean runtimeVisible) Creates a builder of annotation instances of given `annotationType`. This allows creating an `AnnotationInstance` in a nicer way than using any of the `create()` methods. Parameters annotationType:DotName the type of annotation whose instance will be created, must not be `null` runtimeVisible:boolean whether the annotation type has the runtime retention Returns:AnnotationInstanceBuilder a builder instance, never `null`

public static AnnotationInstanceBuilder builder(DotName annotationType, boolean runtimeVisible)

Creates a builder of annotation instances of given annotationType. This allows creating an AnnotationInstance in a nicer way than using any of the create() methods.

Parameters

annotationType:DotName: the type of annotation whose instance will be created, must not be null
runtimeVisible:boolean: whether the annotation type has the runtime retention

Returns:AnnotationInstanceBuilder

a builder instance, never null

create	back to summary
pack-priv static AnnotationInstance create(AnnotationInstance instance, AnnotationTarget target)

create back to summary

create	back to summary
public static AnnotationInstance create(DotName name, AnnotationTarget target, AnnotationValue[] values) Construct a new mock annotation instance. The passed `values` array will be defensively copied. It is assumed that the annotation is `runtimeVisible()`. Parameters name:DotName the name of the annotation instance target:AnnotationTarget the thing the annotation is declared on values:AnnotationValue[] the members of this annotation instance Returns:AnnotationInstance the new mock Annotation Instance

public static AnnotationInstance create(DotName name, AnnotationTarget target, AnnotationValue[] values)

Construct a new mock annotation instance. The passed values array will be defensively copied. It is assumed that the annotation is runtimeVisible().

Parameters

name:DotName: the name of the annotation instance
target:AnnotationTarget: the thing the annotation is declared on
values:AnnotationValue[]: the members of this annotation instance

Returns:AnnotationInstance

the new mock Annotation Instance

create back to summary

create	back to summary
public static AnnotationInstance create(DotName name, boolean visible, AnnotationTarget target, AnnotationValue[] values) Construct a new mock annotation instance. The passed `values` array will be defensively copied. Parameters name:DotName the name of the annotation instance visible:boolean whether the annotation is visible at runtime via the reflection API target:AnnotationTarget the thing the annotation is declared on values:AnnotationValue[] the members of this annotation instance Returns:AnnotationInstance the new mock Annotation Instance

public static AnnotationInstance create(DotName name, boolean visible, AnnotationTarget target, AnnotationValue[] values)

Construct a new mock annotation instance. The passed values array will be defensively copied.

Parameters

name:DotName: the name of the annotation instance
visible:boolean: whether the annotation is visible at runtime via the reflection API
target:AnnotationTarget: the thing the annotation is declared on
values:AnnotationValue[]: the members of this annotation instance

Returns:AnnotationInstance

the new mock Annotation Instance

create back to summary

create	back to summary
public static AnnotationInstance create(DotName name, AnnotationTarget target, List<AnnotationValue> values) Construct a new mock annotation instance. The passed `values` list will be defensively copied. It is assumed that the annotation is `runtimeVisible()`. Parameters name:DotName the name of the annotation instance target:AnnotationTarget the thing the annotation is declared on values:List<AnnotationValue> the members of this annotation instance Returns:AnnotationInstance the new mock Annotation Instance

public static AnnotationInstance create(DotName name, AnnotationTarget target, List<AnnotationValue> values)

Construct a new mock annotation instance. The passed values list will be defensively copied. It is assumed that the annotation is runtimeVisible().

Parameters

name:DotName: the name of the annotation instance
target:AnnotationTarget: the thing the annotation is declared on
values:List<AnnotationValue>: the members of this annotation instance

Returns:AnnotationInstance

the new mock Annotation Instance

create back to summary

create	back to summary
public static AnnotationInstance create(DotName name, boolean visible, AnnotationTarget target, List<AnnotationValue> values) Construct a new mock annotation instance. The passed `values` list will be defensively copied. Parameters name:DotName the name of the annotation instance visible:boolean whether the annotation is visible at runtime via the reflection API target:AnnotationTarget the thing the annotation is declared on values:List<AnnotationValue> the members of this annotation instance Returns:AnnotationInstance the new mock Annotation Instance

public static AnnotationInstance create(DotName name, boolean visible, AnnotationTarget target, List<AnnotationValue> values)

Construct a new mock annotation instance. The passed values list will be defensively copied.

Parameters

name:DotName: the name of the annotation instance
visible:boolean: whether the annotation is visible at runtime via the reflection API
target:AnnotationTarget: the thing the annotation is declared on
values:List<AnnotationValue>: the members of this annotation instance

Returns:AnnotationInstance

the new mock Annotation Instance

createEquivalenceProxy	back to summary
public AnnotationInstanceEquivalenceProxy createEquivalenceProxy() Returns an equivalence proxy for this annotation instance.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Returns whether this annotation instance is equal to another instance. Two annotation instances are equal if their names and values of their members are equal, and they share the exact same `AnnotationTarget` instance. Parameters o:Object the annotation instance to compare to Returns:boolean `true` if equal, `false` if not Annotations @Override See Also `Object#equals(Object)`

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Returns whether this annotation instance is equal to another instance. Two annotation instances are equal if their names and values of their members are equal, and they share the exact same AnnotationTarget instance.

Parameters

o:Object: the annotation instance to compare to

Returns:boolean

true if equal, false if not

Annotations

@Override

See Also

Object#equals(Object)

equivalenceHashCode back to summary

equivalenceHashCode	back to summary
public int equivalenceHashCode() Returns an equivalence hash code. This is consistent with `equivalentTo(AnnotationInstance)`, therefore no attention is paid to the annotation target. Returns:int hash code consistent with annotation equivalence

public int equivalenceHashCode()

Returns an equivalence hash code. This is consistent with equivalentTo(AnnotationInstance), therefore no attention is paid to the annotation target.

Returns:int: hash code consistent with annotation equivalence

equivalentTo back to summary

equivalentTo	back to summary
public boolean equivalentTo(AnnotationInstance other) Returns whether this annotation instance is equivalent to the `other` annotation instance. Two annotation instances are equivalent if their names and members are equal. No attention is paid to the annotation target. Parameters other:AnnotationInstance the annotation instance to compare to Returns:boolean `true` if equivalent, `false` if not See Also `equals(Object)`

public boolean equivalentTo(AnnotationInstance other)

Returns whether this annotation instance is equivalent to the other annotation instance. Two annotation instances are equivalent if their names and members are equal. No attention is paid to the annotation target.

Parameters

other:AnnotationInstance: the annotation instance to compare to

Returns:boolean

true if equivalent, false if not

See Also

equals(Object)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code representing this object. Returns:int the hash code of this object Annotations @Override See Also `Object#hashCode()`

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code representing this object.

Returns:int

the hash code of this object

Annotations

@Override

See Also

Object#hashCode()

name	back to summary
public DotName name() The name of this annotation in DotName form. Returns:DotName the name of this annotation

name

back to summary

public DotName name()

The name of this annotation in DotName form.

Returns:DotName: the name of this annotation

runtimeVisible	back to summary
public boolean runtimeVisible() Returns true if this annotation uses RetentionPolicy.RUNTIME and is visible to runtime reflection. Since 3.0

runtimeVisible

back to summary

public boolean runtimeVisible()

Returns true if this annotation uses RetentionPolicy.RUNTIME and is visible to runtime reflection.

Since: 3.0

target back to summary

target	back to summary
public AnnotationTarget target() The program element that this annotation was declared on. This can be a class, a field, a method, a method parameter, or a type in case of type annotations. In addition, it may be `null` if this instance is a nested annotation, in which case there is no target. Returns:AnnotationTarget the target this annotation instance refers to

public AnnotationTarget target()

The program element that this annotation was declared on. This can be a class, a field, a method, a method parameter, or a type in case of type annotations. In addition, it may be null if this instance is a nested annotation, in which case there is no target.

Returns:AnnotationTarget: the target this annotation instance refers to

toString	back to summary
public String toString(boolean simple) Returns an optionally simplified string that represents this annotation instance. If simplified the output is smaller but missing information, such as the package qualifier. Parameters simple:boolean whether to provide a simpler string representation Returns:String a string representation for this object Since 2.0

toString

back to summary

public String toString(boolean simple)

Returns an optionally simplified string that represents this annotation instance. If simplified the output is smaller but missing information, such as the package qualifier.

Parameters

simple:boolean: whether to provide a simpler string representation

Returns:String

a string representation for this object

Since

2.0

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation for this annotation instance. This method is equivalent to calling `toString(boolean)` with a value of `true`. Returns:String a simple string representation for this annotation instance

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation for this annotation instance. This method is equivalent to calling toString(boolean) with a value of true.

Returns:String: a simple string representation for this annotation instance

value back to summary

value	back to summary
public AnnotationValue value(final String name) Returns the member of this annotation that has the specified name. If the member was not specified by this instance, `null` is returned. Note that this also applies to a defaulted member, whose value is not recorded in the target class file. Parameters name:String the name of the annotation member Returns:AnnotationValue the annotation member with specified name, or `null`

public AnnotationValue value(final String name)

Returns the member of this annotation that has the specified name. If the member was not specified by this instance, null is returned. Note that this also applies to a defaulted member, whose value is not recorded in the target class file.

Parameters

name:String: the name of the annotation member

Returns:AnnotationValue

the annotation member with specified name, or null

value back to summary

value	back to summary
public AnnotationValue value() Returns the member that has the special default name `value`. Returns:AnnotationValue the `value` member

public AnnotationValue value()

Returns the member that has the special default name value.

Returns:AnnotationValue: the value member

valueArray	back to summary
pack-priv AnnotationValue[] valueArray()

values	back to summary
public List<AnnotationValue> values() Returns an immutable list of all members of this annotation instance. While random access is allowed, the ordering algorithm of the list should not be relied upon. Although it will be consistent for the life of this instance. Returns:List<AnnotationValue> immutable list of this annotation's members

values

back to summary

public List<AnnotationValue> values()

Returns an immutable list of all members of this annotation instance. While random access is allowed, the ordering algorithm of the list should not be relied upon. Although it will be consistent for the life of this instance.

Returns:List<AnnotationValue>: immutable list of this annotation's members

valuesWithDefaults back to summary

valuesWithDefaults	back to summary
public List<AnnotationValue> valuesWithDefaults(IndexView index) Returns a list of all members of this annotation instance, including default values if defined. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an `IllegalArgumentException` will be thrown to prevent non-deterministic results. The order of this list is undefined. Returns:List<AnnotationValue> immutable list of this annotation's members Exceptions IllegalArgumentException: if index does not contain the defining annotation class Since 2.1

public List<AnnotationValue> valuesWithDefaults(IndexView index)

Returns a list of all members of this annotation instance, including default values if defined. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an IllegalArgumentException will be thrown to prevent non-deterministic results.

The order of this list is undefined.

Returns:List<AnnotationValue>

immutable list of this annotation's members

Exceptions

IllegalArgumentException:: if index does not contain the defining annotation class

Since

2.1

valueWithDefault back to summary

valueWithDefault	back to summary
public AnnotationValue valueWithDefault(IndexView index, String name) Returns the member of this annotation that has the specified name, accounting for its default value. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an `IllegalArgumentException` will be thrown to prevent non-deterministic results. If the member was not specified by this annotation instance, then the annotation's `ClassInfo` is checked for a default value. If there is a default, that value is returned. Otherwise `null` is returned. Parameters index:IndexView the index containing the defining annotation class name:String the name of the annotation member Returns:AnnotationValue the annotation member with specified name, or `null` Exceptions IllegalArgumentException: if index does not contain the defining annotation class Since 2.1

public AnnotationValue valueWithDefault(IndexView index, String name)

Returns the member of this annotation that has the specified name, accounting for its default value. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an IllegalArgumentException will be thrown to prevent non-deterministic results.

If the member was not specified by this annotation instance, then the annotation's ClassInfo is checked for a default value. If there is a default, that value is returned. Otherwise null is returned.

Parameters

index:IndexView: the index containing the defining annotation class
name:String: the name of the annotation member

Returns:AnnotationValue

the annotation member with specified name, or null

Exceptions

IllegalArgumentException:: if index does not contain the defining annotation class

Since

2.1

valueWithDefault back to summary

valueWithDefault	back to summary
public AnnotationValue valueWithDefault(IndexView index) Returns the member of this annotation that has special name `value`, accounting for its default value. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an `IllegalArgumentException` will be thrown to prevent non-deterministic results. If the `value` member was not specified by this instance, then the annotation's `ClassInfo` is checked for a default value. If there is a default, that value is returned. Otherwise `null` is returned. Parameters index:IndexView the index containing the defining annotation class Returns:AnnotationValue the `value` annotation member, or `null` Exceptions IllegalArgumentException: if index does not contain the defining annotation class Since 2.1

public AnnotationValue valueWithDefault(IndexView index)

Returns the member of this annotation that has special name value, accounting for its default value. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an IllegalArgumentException will be thrown to prevent non-deterministic results.

If the value member was not specified by this instance, then the annotation's ClassInfo is checked for a default value. If there is a default, that value is returned. Otherwise null is returned.

Parameters

index:IndexView: the index containing the defining annotation class

Returns:AnnotationValue

the value annotation member, or null

Exceptions

IllegalArgumentException:: if index does not contain the defining annotation class

Since

2.1

public final Class AnnotationInstance

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class AnnotationInstance.NameComparator

Constructor Summary

Method Summary

Constructor Detail

Method Detail