OpenJDK 1.23 · java.lang.constant.DynamicConstantDesc

Modifier and Type	Class and Description
private static class	DynamicConstantDesc.AnonymousDynamicConstantDesc<T>
private static class	DynamicConstantDesc.CanonicalMapHolder

Modifier and Type	Field and Description
private final ConstantDesc[]	bootstrapArgs
private final DirectMethodHandleDesc	bootstrapMethod
private final String	constantName
private final ClassDesc	constantType

Access	Constructor and Description
protected	DynamicConstantDesc(DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant bootstrapMethod, String The unqualified name that would appear in the `NameAndType` operand of the `LDC` for this constant constantName, ClassDesc a `ClassDesc` describing the type that would appear in the `NameAndType` operand of the `LDC` for this constant constantType, ConstantDesc... `ConstantDesc`s describing the static arguments to the bootstrap, that would appear in the `BootstrapMethods` attribute bootstrapArgs) Creates a nominal descriptor for a dynamic constant.

Method Summary

Modifier and Type	Method and Description
public ConstantDesc[]	Returns: the bootstrap arguments bootstrapArgs() Returns the bootstrap arguments for this constant.
public List<ConstantDesc>	Returns: a `List` of the bootstrap arguments bootstrapArgsList() Returns the bootstrap arguments for this constant as an immutable `List`.
public DirectMethodHandleDesc	Returns: the bootstrap method bootstrapMethod() Returns a `MethodHandleDesc` describing the bootstrap method for this constant.
private static ConstantDesc	canonicalizeArrayVarHandle(DynamicConstantDesc<?> desc)
private static ConstantDesc	canonicalizeEnum(DynamicConstantDesc<?> desc)
private static ConstantDesc	canonicalizeFieldVarHandle(DynamicConstantDesc<?> desc)
private static ConstantDesc	canonicalizeNull(DynamicConstantDesc<?> desc)
private static ConstantDesc	canonicalizePrimitiveClass(DynamicConstantDesc<?> desc)
private static ConstantDesc	canonicalizeStaticFieldVarHandle(DynamicConstantDesc<?> desc)
public String	Returns: the constant name constantName() Returns the name that would appear in the `NameAndType` operand of the `LDC` for this constant.
public ClassDesc	Returns: the constant type constantType() Returns a `ClassDesc` describing the type that would appear in the `NameAndType` operand of the `LDC` for this constant.
public final boolean	Returns: `true` if the specified `DynamicConstantDesc` is equal to this `DynamicConstantDesc`. equals(Object the `DynamicConstantDesc` to compare to this `DynamicConstantDesc` o) Overrides java.lang.Object.equals. Compares the specified object with this descriptor for equality.
public final int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static < the type of the dynamic constant T> DynamicConstantDesc<T>	Returns: the nominal descriptor of(DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant bootstrapMethod, ConstantDesc... `ConstantDesc`s describing the static arguments to the bootstrap, that would appear in the `BootstrapMethods` attribute bootstrapArgs) Returns a nominal descriptor for a dynamic constant whose name parameter is `ConstantDescs#DEFAULT_NAME`, and whose type parameter is always the same as the bootstrap method return type.
public static < the type of the dynamic constant T> DynamicConstantDesc<T>	Returns: the nominal descriptor of(DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant bootstrapMethod) Returns a nominal descriptor for a dynamic constant whose bootstrap has no static arguments, whose name parameter is `ConstantDescs#DEFAULT_NAME`, and whose type parameter is always the same as the bootstrap method return type.
public static < the type of the dynamic constant T> ConstantDesc	Returns: the nominal descriptor ofCanonical(DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant bootstrapMethod, String The unqualified name that would appear in the `NameAndType` operand of the `LDC` for this constant constantName, ClassDesc a `ClassDesc` describing the type that would appear in the `NameAndType` operand of the `LDC` for this constant constantType, ConstantDesc[] `ConstantDesc`s describing the static arguments to the bootstrap, that would appear in the `BootstrapMethods` attribute bootstrapArgs) Returns a nominal descriptor for a dynamic constant, transforming it into a more specific type if the constant bootstrap is a well-known one and a more specific nominal descriptor type (e.g., ClassDesc) is available.
public static < the type of the dynamic constant T> DynamicConstantDesc<T>	Returns: the nominal descriptor ofNamed(DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant bootstrapMethod, String The unqualified name that would appear in the `NameAndType` operand of the `LDC` for this constant constantName, ClassDesc a `ClassDesc` describing the type that would appear in the `NameAndType` operand of the `LDC` for this constant constantType, ConstantDesc... `ConstantDesc`s describing the static arguments to the bootstrap, that would appear in the `BootstrapMethods` attribute bootstrapArgs) Returns a nominal descriptor for a dynamic constant.
public T	resolveConstantDesc(MethodHandles.Lookup The `MethodHandles.Lookup` to provide name resolution and access control context lookup) Implements java.lang.constant.ConstantDesc.resolveConstantDesc. Resolves this descriptor reflectively, emulating the resolution behavior of JVMS 5.4.3 and the access control behavior of JVMS 5.4.4.
public String	Returns: A compact textual description of this call site descriptor toString() Overrides java.lang.Object.toString. Returns a compact textual description of this constant description, including the bootstrap method, the constant name and type, and the static bootstrap arguments.
private ConstantDesc	tryCanonicalize()

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

bootstrapArgs	back to summary
private final ConstantDesc[] bootstrapArgs

bootstrapMethod	back to summary
private final DirectMethodHandleDesc bootstrapMethod

constantName	back to summary
private final String constantName

constantType	back to summary
private final ClassDesc constantType

DynamicConstantDesc	back to summary
protected DynamicConstantDesc(DirectMethodHandleDesc bootstrapMethod, String constantName, ClassDesc constantType, ConstantDesc... bootstrapArgs) Creates a nominal descriptor for a dynamic constant. Parameters bootstrapMethod:DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant constantName:String The unqualified name that would appear in the `NameAndType` operand of the `LDC` for this constant constantType:ClassDesc a `ClassDesc` describing the type that would appear in the `NameAndType` operand of the `LDC` for this constant bootstrapArgs:ConstantDesc[] `ConstantDesc`s describing the static arguments to the bootstrap, that would appear in the `BootstrapMethods` attribute Exceptions NullPointerException: if any argument is null IllegalArgumentException: if the `name` has the incorrect format Java Virtual Machine Specification 4.2.2 Unqualified Names

Method Detail

bootstrapArgs	back to summary
public ConstantDesc[] bootstrapArgs() Returns the bootstrap arguments for this constant. Returns:ConstantDesc[] the bootstrap arguments

bootstrapArgs

back to summary

public ConstantDesc[] bootstrapArgs()

Returns the bootstrap arguments for this constant.

Returns:ConstantDesc[]: the bootstrap arguments

bootstrapArgsList back to summary

bootstrapArgsList	back to summary
public List<ConstantDesc> bootstrapArgsList() Returns the bootstrap arguments for this constant as an immutable `List`. Returns:List<ConstantDesc> a `List` of the bootstrap arguments

public List<ConstantDesc> bootstrapArgsList()

Returns the bootstrap arguments for this constant as an immutable List.

Returns:List<ConstantDesc>: a List of the bootstrap arguments

bootstrapMethod back to summary

bootstrapMethod	back to summary
public DirectMethodHandleDesc bootstrapMethod() Returns a `MethodHandleDesc` describing the bootstrap method for this constant. Returns:DirectMethodHandleDesc the bootstrap method

public DirectMethodHandleDesc bootstrapMethod()

Returns a MethodHandleDesc describing the bootstrap method for this constant.

Returns:DirectMethodHandleDesc: the bootstrap method

canonicalizeArrayVarHandle	back to summary
private static ConstantDesc canonicalizeArrayVarHandle(DynamicConstantDesc<?> desc)

canonicalizeEnum	back to summary
private static ConstantDesc canonicalizeEnum(DynamicConstantDesc<?> desc)

canonicalizeFieldVarHandle	back to summary
private static ConstantDesc canonicalizeFieldVarHandle(DynamicConstantDesc<?> desc)

canonicalizeNull	back to summary
private static ConstantDesc canonicalizeNull(DynamicConstantDesc<?> desc)

canonicalizePrimitiveClass	back to summary
private static ConstantDesc canonicalizePrimitiveClass(DynamicConstantDesc<?> desc)

canonicalizeStaticFieldVarHandle	back to summary
private static ConstantDesc canonicalizeStaticFieldVarHandle(DynamicConstantDesc<?> desc)

constantName back to summary

constantName	back to summary
public String constantName() Returns the name that would appear in the `NameAndType` operand of the `LDC` for this constant. Returns:String the constant name

public String constantName()

Returns the name that would appear in the NameAndType operand of the LDC for this constant.

Returns:String: the constant name

constantType back to summary

constantType	back to summary
public ClassDesc constantType() Returns a `ClassDesc` describing the type that would appear in the `NameAndType` operand of the `LDC` for this constant. Returns:ClassDesc the constant type

public ClassDesc constantType()

Returns a ClassDesc describing the type that would appear in the NameAndType operand of the LDC for this constant.

Returns:ClassDesc: the constant type

equals back to summary

equals	back to summary
public final boolean equals(Object o) Overrides java.lang.Object.equals. Compares the specified object with this descriptor for equality. Returns `true` if and only if the specified object is also a DynamicConstantDesc, and both descriptors have equal bootstrap methods, bootstrap argument lists, constant name, and constant type. Parameters o:Object the `DynamicConstantDesc` to compare to this `DynamicConstantDesc` Returns:boolean `true` if the specified `DynamicConstantDesc` is equal to this `DynamicConstantDesc`. Annotations @Override

public final boolean equals(Object o)

Overrides java.lang.Object.equals.

Compares the specified object with this descriptor for equality. Returns true if and only if the specified object is also a DynamicConstantDesc, and both descriptors have equal bootstrap methods, bootstrap argument lists, constant name, and constant type.

Parameters

o:Object: the DynamicConstantDesc to compare to this DynamicConstantDesc

Returns:boolean

true if the specified DynamicConstantDesc is equal to this DynamicConstantDesc.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public final int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this 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 final int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this 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

of back to summary

of	back to summary
public static <T> DynamicConstantDesc<T> of(DirectMethodHandleDesc bootstrapMethod, ConstantDesc... bootstrapArgs) Returns a nominal descriptor for a dynamic constant whose name parameter is `ConstantDescs#DEFAULT_NAME`, and whose type parameter is always the same as the bootstrap method return type. Parameters <T> the type of the dynamic constant bootstrapMethod:DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant bootstrapArgs:ConstantDesc[] `ConstantDesc`s describing the static arguments to the bootstrap, that would appear in the `BootstrapMethods` attribute Returns:DynamicConstantDesc<T> the nominal descriptor Exceptions NullPointerException: if any argument is null Java Virtual Machine Specification 4.2.2 Unqualified Names

public static <T> DynamicConstantDesc<T> of(DirectMethodHandleDesc bootstrapMethod, ConstantDesc... bootstrapArgs)

Returns a nominal descriptor for a dynamic constant whose name parameter is ConstantDescs#DEFAULT_NAME, and whose type parameter is always the same as the bootstrap method return type.

Parameters

<T>: the type of the dynamic constant
bootstrapMethod:DirectMethodHandleDesc: a DirectMethodHandleDesc describing the bootstrap method for the constant
bootstrapArgs:ConstantDesc[]: ConstantDescs describing the static arguments to the bootstrap, that would appear in the BootstrapMethods attribute

Returns:DynamicConstantDesc<T>

the nominal descriptor

Exceptions

NullPointerException:: if any argument is null

Java Virtual Machine Specification

4.2.2 Unqualified Names

of back to summary

of	back to summary
public static <T> DynamicConstantDesc<T> of(DirectMethodHandleDesc bootstrapMethod) Returns a nominal descriptor for a dynamic constant whose bootstrap has no static arguments, whose name parameter is `ConstantDescs#DEFAULT_NAME`, and whose type parameter is always the same as the bootstrap method return type. Parameters <T> the type of the dynamic constant bootstrapMethod:DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant Returns:DynamicConstantDesc<T> the nominal descriptor Exceptions NullPointerException: if any argument is null

public static <T> DynamicConstantDesc<T> of(DirectMethodHandleDesc bootstrapMethod)

Returns a nominal descriptor for a dynamic constant whose bootstrap has no static arguments, whose name parameter is ConstantDescs#DEFAULT_NAME, and whose type parameter is always the same as the bootstrap method return type.

Parameters

<T>: the type of the dynamic constant
bootstrapMethod:DirectMethodHandleDesc: a DirectMethodHandleDesc describing the bootstrap method for the constant

Returns:DynamicConstantDesc<T>

the nominal descriptor

Exceptions

NullPointerException:: if any argument is null

ofCanonical back to summary

ofCanonical	back to summary
public static <T> ConstantDesc ofCanonical(DirectMethodHandleDesc bootstrapMethod, String constantName, ClassDesc constantType, ConstantDesc[] bootstrapArgs) Returns a nominal descriptor for a dynamic constant, transforming it into a more specific type if the constant bootstrap is a well-known one and a more specific nominal descriptor type (e.g., ClassDesc) is available. Classes whose `Constable#describeConstable()` method produce a DynamicConstantDesc with a well-known bootstrap including `Class` (for instances describing primitive types), `Enum`, and `VarHandle`. Bytecode-reading APIs that process the constant pool and wish to expose entries as `ConstantDesc` to their callers should generally use this method in preference to `ofNamed(DirectMethodHandleDesc, String, ClassDesc, ConstantDesc...)` because this may result in a more specific type that can be provided to callers. Parameters <T> the type of the dynamic constant bootstrapMethod:DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant constantName:String The unqualified name that would appear in the `NameAndType` operand of the `LDC` for this constant constantType:ClassDesc a `ClassDesc` describing the type that would appear in the `NameAndType` operand of the `LDC` for this constant bootstrapArgs:ConstantDesc[] `ConstantDesc`s describing the static arguments to the bootstrap, that would appear in the `BootstrapMethods` attribute Returns:ConstantDesc the nominal descriptor Exceptions NullPointerException: if any argument is null IllegalArgumentException: if the `name` has the incorrect format Java Virtual Machine Specification 4.2.2 Unqualified Names

public static <T> ConstantDesc ofCanonical(DirectMethodHandleDesc bootstrapMethod, String constantName, ClassDesc constantType, ConstantDesc[] bootstrapArgs)

Returns a nominal descriptor for a dynamic constant, transforming it into a more specific type if the constant bootstrap is a well-known one and a more specific nominal descriptor type (e.g., ClassDesc) is available.

Classes whose Constable#describeConstable() method produce a DynamicConstantDesc with a well-known bootstrap including Class (for instances describing primitive types), Enum, and VarHandle.

Bytecode-reading APIs that process the constant pool and wish to expose entries as ConstantDesc to their callers should generally use this method in preference to ofNamed(DirectMethodHandleDesc, String, ClassDesc, ConstantDesc...) because this may result in a more specific type that can be provided to callers.

Parameters

<T>: the type of the dynamic constant
bootstrapMethod:DirectMethodHandleDesc: a DirectMethodHandleDesc describing the bootstrap method for the constant
constantName:String: The unqualified name that would appear in the NameAndType operand of the LDC for this constant
constantType:ClassDesc: a ClassDesc describing the type that would appear in the NameAndType operand of the LDC for this constant
bootstrapArgs:ConstantDesc[]: ConstantDescs describing the static arguments to the bootstrap, that would appear in the BootstrapMethods attribute

Returns:ConstantDesc

the nominal descriptor

Exceptions

NullPointerException:: if any argument is null
IllegalArgumentException:: if the name has the incorrect format

Java Virtual Machine Specification

4.2.2 Unqualified Names

ofNamed back to summary

ofNamed	back to summary
public static <T> DynamicConstantDesc<T> ofNamed(DirectMethodHandleDesc bootstrapMethod, String constantName, ClassDesc constantType, ConstantDesc... bootstrapArgs) Returns a nominal descriptor for a dynamic constant. Parameters <T> the type of the dynamic constant bootstrapMethod:DirectMethodHandleDesc a `DirectMethodHandleDesc` describing the bootstrap method for the constant constantName:String The unqualified name that would appear in the `NameAndType` operand of the `LDC` for this constant constantType:ClassDesc a `ClassDesc` describing the type that would appear in the `NameAndType` operand of the `LDC` for this constant bootstrapArgs:ConstantDesc[] `ConstantDesc`s describing the static arguments to the bootstrap, that would appear in the `BootstrapMethods` attribute Returns:DynamicConstantDesc<T> the nominal descriptor Exceptions NullPointerException: if any argument is null IllegalArgumentException: if the `name` has the incorrect format Java Virtual Machine Specification 4.2.2 Unqualified Names

public static <T> DynamicConstantDesc<T> ofNamed(DirectMethodHandleDesc bootstrapMethod, String constantName, ClassDesc constantType, ConstantDesc... bootstrapArgs)

Returns a nominal descriptor for a dynamic constant.

Parameters

<T>: the type of the dynamic constant
bootstrapMethod:DirectMethodHandleDesc: a DirectMethodHandleDesc describing the bootstrap method for the constant
constantName:String: The unqualified name that would appear in the NameAndType operand of the LDC for this constant
constantType:ClassDesc: a ClassDesc describing the type that would appear in the NameAndType operand of the LDC for this constant
bootstrapArgs:ConstantDesc[]: ConstantDescs describing the static arguments to the bootstrap, that would appear in the BootstrapMethods attribute

Returns:DynamicConstantDesc<T>

the nominal descriptor

Exceptions

NullPointerException:: if any argument is null
IllegalArgumentException:: if the name has the incorrect format

Java Virtual Machine Specification

4.2.2 Unqualified Names

resolveConstantDesc back to summary

resolveConstantDesc	back to summary
public T resolveConstantDesc(MethodHandles.Lookup lookup) throws ReflectiveOperationException Implements java.lang.constant.ConstantDesc.resolveConstantDesc. Doc from java.lang.constant.ConstantDesc.resolveConstantDesc. Resolves this descriptor reflectively, emulating the resolution behavior of JVMS 5.4.3 and the access control behavior of JVMS 5.4.4. The resolution and access control context is provided by the `MethodHandles.Lookup` parameter. No caching of the resulting value is performed. Parameters lookup:MethodHandles.Lookup The `MethodHandles.Lookup` to provide name resolution and access control context Returns:T the resolved constant value Annotations @SuppressWarnings:unchecked Exceptions ReflectiveOperationException: if a class, method, or field could not be reflectively resolved in the course of resolution

public T resolveConstantDesc(MethodHandles.Lookup lookup) throws ReflectiveOperationException

Implements java.lang.constant.ConstantDesc.resolveConstantDesc.

Doc from java.lang.constant.ConstantDesc.resolveConstantDesc.

Resolves this descriptor reflectively, emulating the resolution behavior of JVMS 5.4.3 and the access control behavior of JVMS 5.4.4. The resolution and access control context is provided by the MethodHandles.Lookup parameter. No caching of the resulting value is performed.

Parameters

lookup:MethodHandles.Lookup: The MethodHandles.Lookup to provide name resolution and access control context

Returns:T

the resolved constant value

Annotations

@SuppressWarnings:unchecked

Exceptions

ReflectiveOperationException:: if a class, method, or field could not be reflectively resolved in the course of resolution

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a compact textual description of this constant description, including the bootstrap method, the constant name and type, and the static bootstrap arguments. Returns:String A compact textual description of this call site descriptor Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Returns a compact textual description of this constant description, including the bootstrap method, the constant name and type, and the static bootstrap arguments.

Returns:String

A compact textual description of this call site descriptor

Annotations

@Override

tryCanonicalize	back to summary
private ConstantDesc tryCanonicalize()

public abstract non-sealed Class DynamicConstantDesc<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DynamicConstantDesc.AnonymousDynamicConstantDesc<T>

Constructor Summary

Method Summary

Constructor Detail

private final Class DynamicConstantDesc.CanonicalMapHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail