OpenJDK 27 · java.lang.classfile.AnnotationElement · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public Utf8Entry	Returns: the element name name() Returns the element name.
public static AnnotationElement	Returns: an element-value pair of(Utf8Entry the name of the key name, AnnotationValue the associated value value) Returns an element-value pair.
public static AnnotationElement	Returns: an element-value pair of(String the name of the key name, AnnotationValue the associated value value) Returns an element-value pair.
public static AnnotationElement	Returns: an element-value pair for an annotation-valued element ofAnnotation(String the name of the key name, Annotation the associated value value) Returns an element-value pair for an annotation-valued element.
public static AnnotationElement	Returns: an element-value pair for an array-valued element ofArray(String the name of the key name, AnnotationValue... the associated values values) Returns an element-value pair for an array-valued element.
public static AnnotationElement	Returns: an element-value pair for a boolean-valued element ofBoolean(String the name of the key name, boolean the associated value value) Returns an element-value pair for a boolean-valued element.
public static AnnotationElement	Returns: an element-value pair for a byte-valued element ofByte(String the name of the key name, byte the associated value value) Returns an element-value pair for a byte-valued element.
public static AnnotationElement	Returns: an element-value pair for a char-valued element ofChar(String the name of the key name, char the associated value value) Returns an element-value pair for a char-valued element.
public static AnnotationElement	Returns: an element-value pair for a class-valued element ofClass(String the name of the key name, ClassDesc the associated value value) Returns an element-value pair for a class-valued element.
public static AnnotationElement	Returns: an element-value pair for a double-valued element ofDouble(String the name of the key name, double the associated value value) Returns an element-value pair for a double-valued element.
public static AnnotationElement	Returns: an element-value pair for a float-valued element ofFloat(String the name of the key name, float the associated value value) Returns an element-value pair for a float-valued element.
public static AnnotationElement	Returns: an element-value pair for an int-valued element ofInt(String the name of the key name, int the associated value value) Returns an element-value pair for an int-valued element.
public static AnnotationElement	Returns: an element-value pair for a long-valued element ofLong(String the name of the key name, long the associated value value) Returns an element-value pair for a long-valued element.
public static AnnotationElement	Returns: an element-value pair for a short-valued element ofShort(String the name of the key name, short the associated value value) Returns an element-value pair for a short-valued element.
public static AnnotationElement	Returns: an element-value pair for a string-valued element ofString(String the name of the key name, String the associated value value) Returns an element-value pair for a string-valued element.
public AnnotationValue	Returns: the element value value() Returns the element value.

Method Detail

name back to summary

name	back to summary
public Utf8Entry name() Returns the element name. API Note In Java source code, by convention, the name of the sole element in a single-element annotation interface is `value`. (JLS 9.6.1) This is the case for single-element annotations (JLS 9.7.3) and container annotations for multiple annotations (JLS 9.6.3). Returns:Utf8Entry the element name

public Utf8Entry name()

Returns the element name.

API Note

In Java source code, by convention, the name of the sole element in a single-element annotation interface is value. (JLS 9.6.1) This is the case for single-element annotations (JLS 9.7.3) and container annotations for multiple annotations (JLS 9.6.3).

Returns:Utf8Entry: the element name

of	back to summary
public static AnnotationElement of(Utf8Entry name, AnnotationValue value) Returns an element-value pair. Parameters name:Utf8Entry the name of the key value:AnnotationValue the associated value Returns:AnnotationElement an element-value pair

back to summary

public static AnnotationElement of(Utf8Entry name, AnnotationValue value)

Returns an element-value pair.

Parameters

name:Utf8Entry: the name of the key
value:AnnotationValue: the associated value

Returns:AnnotationElement

an element-value pair

of	back to summary
public static AnnotationElement of(String name, AnnotationValue value) Returns an element-value pair. Parameters name:String the name of the key value:AnnotationValue the associated value Returns:AnnotationElement an element-value pair

back to summary

public static AnnotationElement of(String name, AnnotationValue value)

Returns an element-value pair.

Parameters

name:String: the name of the key
value:AnnotationValue: the associated value

Returns:AnnotationElement

an element-value pair

ofAnnotation back to summary

ofAnnotation	back to summary
public static AnnotationElement ofAnnotation(String name, Annotation value) Returns an element-value pair for an annotation-valued element. Parameters name:String the name of the key value:Annotation the associated value Returns:AnnotationElement an element-value pair for an annotation-valued element See Also `AnnotationValue::ofAnnotation`

public static AnnotationElement ofAnnotation(String name, Annotation value)

Returns an element-value pair for an annotation-valued element.

Parameters

name:String: the name of the key
value:Annotation: the associated value

Returns:AnnotationElement

an element-value pair for an annotation-valued element

See Also

AnnotationValue::ofAnnotation

ofArray back to summary

ofArray	back to summary
public static AnnotationElement ofArray(String name, AnnotationValue... values) Returns an element-value pair for an array-valued element. Parameters name:String the name of the key values:AnnotationValue[] the associated values Returns:AnnotationElement an element-value pair for an array-valued element Exceptions IllegalArgumentException: if the number of associated values exceeds the limit of `u2` See Also `AnnotationValue::ofArray`

public static AnnotationElement ofArray(String name, AnnotationValue... values)

Returns an element-value pair for an array-valued element.

Parameters

name:String: the name of the key
values:AnnotationValue[]: the associated values

Returns:AnnotationElement

an element-value pair for an array-valued element

Exceptions

IllegalArgumentException:: if the number of associated values exceeds the limit of u2

See Also

AnnotationValue::ofArray

ofBoolean back to summary

ofBoolean	back to summary
public static AnnotationElement ofBoolean(String name, boolean value) Returns an element-value pair for a boolean-valued element. Parameters name:String the name of the key value:boolean the associated value Returns:AnnotationElement an element-value pair for a boolean-valued element See Also `AnnotationValue::ofBoolean`

public static AnnotationElement ofBoolean(String name, boolean value)

Returns an element-value pair for a boolean-valued element.

Parameters

name:String: the name of the key
value:boolean: the associated value

Returns:AnnotationElement

an element-value pair for a boolean-valued element

See Also

AnnotationValue::ofBoolean

ofByte back to summary

ofByte	back to summary
public static AnnotationElement ofByte(String name, byte value) Returns an element-value pair for a byte-valued element. Parameters name:String the name of the key value:byte the associated value Returns:AnnotationElement an element-value pair for a byte-valued element See Also `AnnotationValue::ofByte`

public static AnnotationElement ofByte(String name, byte value)

Returns an element-value pair for a byte-valued element.

Parameters

name:String: the name of the key
value:byte: the associated value

Returns:AnnotationElement

an element-value pair for a byte-valued element

See Also

AnnotationValue::ofByte

ofChar back to summary

ofChar	back to summary
public static AnnotationElement ofChar(String name, char value) Returns an element-value pair for a char-valued element. Parameters name:String the name of the key value:char the associated value Returns:AnnotationElement an element-value pair for a char-valued element See Also `AnnotationValue::ofChar`

public static AnnotationElement ofChar(String name, char value)

Returns an element-value pair for a char-valued element.

Parameters

name:String: the name of the key
value:char: the associated value

Returns:AnnotationElement

an element-value pair for a char-valued element

See Also

AnnotationValue::ofChar

ofClass back to summary

ofClass	back to summary
public static AnnotationElement ofClass(String name, ClassDesc value) Returns an element-value pair for a class-valued element. Parameters name:String the name of the key value:ClassDesc the associated value Returns:AnnotationElement an element-value pair for a class-valued element See Also `AnnotationValue::ofClass`

public static AnnotationElement ofClass(String name, ClassDesc value)

Returns an element-value pair for a class-valued element.

Parameters

name:String: the name of the key
value:ClassDesc: the associated value

Returns:AnnotationElement

an element-value pair for a class-valued element

See Also

AnnotationValue::ofClass

ofDouble back to summary

ofDouble	back to summary
public static AnnotationElement ofDouble(String name, double value) Returns an element-value pair for a double-valued element. Parameters name:String the name of the key value:double the associated value Returns:AnnotationElement an element-value pair for a double-valued element See Also `AnnotationValue::ofDouble`

public static AnnotationElement ofDouble(String name, double value)

Returns an element-value pair for a double-valued element.

Parameters

name:String: the name of the key
value:double: the associated value

Returns:AnnotationElement

an element-value pair for a double-valued element

See Also

AnnotationValue::ofDouble

ofFloat back to summary

ofFloat	back to summary
public static AnnotationElement ofFloat(String name, float value) Returns an element-value pair for a float-valued element. Parameters name:String the name of the key value:float the associated value Returns:AnnotationElement an element-value pair for a float-valued element See Also `AnnotationValue::ofFloat`

public static AnnotationElement ofFloat(String name, float value)

Returns an element-value pair for a float-valued element.

Parameters

name:String: the name of the key
value:float: the associated value

Returns:AnnotationElement

an element-value pair for a float-valued element

See Also

AnnotationValue::ofFloat

ofInt back to summary

ofInt	back to summary
public static AnnotationElement ofInt(String name, int value) Returns an element-value pair for an int-valued element. Parameters name:String the name of the key value:int the associated value Returns:AnnotationElement an element-value pair for an int-valued element See Also `AnnotationValue::ofInt`

public static AnnotationElement ofInt(String name, int value)

Returns an element-value pair for an int-valued element.

Parameters

name:String: the name of the key
value:int: the associated value

Returns:AnnotationElement

an element-value pair for an int-valued element

See Also

AnnotationValue::ofInt

ofLong back to summary

ofLong	back to summary
public static AnnotationElement ofLong(String name, long value) Returns an element-value pair for a long-valued element. Parameters name:String the name of the key value:long the associated value Returns:AnnotationElement an element-value pair for a long-valued element See Also `AnnotationValue::ofLong`

public static AnnotationElement ofLong(String name, long value)

Returns an element-value pair for a long-valued element.

Parameters

name:String: the name of the key
value:long: the associated value

Returns:AnnotationElement

an element-value pair for a long-valued element

See Also

AnnotationValue::ofLong

ofShort back to summary

ofShort	back to summary
public static AnnotationElement ofShort(String name, short value) Returns an element-value pair for a short-valued element. Parameters name:String the name of the key value:short the associated value Returns:AnnotationElement an element-value pair for a short-valued element See Also `AnnotationValue::ofShort`

public static AnnotationElement ofShort(String name, short value)

Returns an element-value pair for a short-valued element.

Parameters

name:String: the name of the key
value:short: the associated value

Returns:AnnotationElement

an element-value pair for a short-valued element

See Also

AnnotationValue::ofShort

ofString back to summary

ofString	back to summary
public static AnnotationElement ofString(String name, String value) Returns an element-value pair for a string-valued element. Parameters name:String the name of the key value:String the associated value Returns:AnnotationElement an element-value pair for a string-valued element See Also `AnnotationValue::ofString`

public static AnnotationElement ofString(String name, String value)

Returns an element-value pair for a string-valued element.

Parameters

name:String: the name of the key
value:String: the associated value

Returns:AnnotationElement

an element-value pair for a string-valued element

See Also

AnnotationValue::ofString

value	back to summary
public AnnotationValue value() Returns the element value. Returns:AnnotationValue the element value

value

back to summary

public AnnotationValue value()

Returns the element value.

Returns:AnnotationValue: the element value

public sealed Interface AnnotationElement

Method Summary

Method Detail