OpenJDK 27 · java.lang.classfile.constantpool.ClassEntry

Models a CONSTANT_Class_info structure, representing a reference type, in the constant pool of a class file.

The use of a ClassEntry is modeled by a ClassDesc that is not primitive. Conversions are through ConstantPoolBuilder#classEntry( ClassDesc) and asSymbol().

A ClassEntry is composite:

ClassEntry(Utf8Entry name)

where name represents:

The internal form of a binary name (JVMS 4.2.1), if and only if this ClassEntry represents a class or interface, such as java/lang/String for the String class.
A field descriptor string (JVMS 4.3.2) representing an array type, if and only if this ClassEntry represents an array type, such as [I for the int[] type, or [Ljava/lang/String; for the String[] type.

A field descriptor string for an array type can be distinguished by its leading '[' character.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the represented reference type, as the internal form of a binary name or an array descriptor string asInternalName() Returns the represented reference type, as the internal form of a binary name or an array descriptor string.
public ClassDesc	Returns: the represented reference type, as a symbolic descriptor asSymbol() Returns the represented reference type, as a symbolic descriptor.
public default ConstantDesc	constantValue() Implements java.lang.classfile.constantpool.LoadableConstantEntry.constantValue. Returns a symbolic descriptor of this constant.
public boolean	Returns: whether this entry describes the given reference type matches(ClassDesc the reference type desc) Returns whether this entry describes the given reference type.
public Utf8Entry	Returns: the `Utf8Entry` referred by this structure name() Returns the `Utf8Entry` referred by this structure.

Inherited from java.lang.classfile.constantpool.LoadableConstantEntry:: typeKind

Method Detail

asInternalName back to summary

asInternalName	back to summary
public String asInternalName() Returns the represented reference type, as the internal form of a binary name or an array descriptor string. This is a shortcut for `name().stringValue()`. Returns:String the represented reference type, as the internal form of a binary name or an array descriptor string

public String asInternalName()

Returns the represented reference type, as the internal form of a binary name or an array descriptor string. This is a shortcut for name().stringValue().

Returns:String: the represented reference type, as the internal form of a binary name or an array descriptor string

asSymbol back to summary

asSymbol	back to summary
public ClassDesc asSymbol() Returns the represented reference type, as a symbolic descriptor. The returned descriptor is never primitive. API Note If only symbol equivalence is desired, `matches` should be used. It requires reduced parsing and can improve `class` file reading performance. Returns:ClassDesc the represented reference type, as a symbolic descriptor See Also `ConstantPoolBuilder::classEntry(ClassDesc)`

public ClassDesc asSymbol()

Returns the represented reference type, as a symbolic descriptor. The returned descriptor is never primitive.

API Note

If only symbol equivalence is desired, matches should be used. It requires reduced parsing and can improve class file reading performance.

Returns:ClassDesc: the represented reference type, as a symbolic descriptor
See Also: ConstantPoolBuilder::classEntry(ClassDesc)

constantValue back to summary

constantValue	back to summary
public default ConstantDesc constantValue() Implements java.lang.classfile.constantpool.LoadableConstantEntry.constantValue. Doc from java.lang.classfile.constantpool.LoadableConstantEntry.constantValue. Returns a symbolic descriptor of this constant. This is equivalent to `asSymbol()`. Annotations @Override

public default ConstantDesc constantValue()

Implements java.lang.classfile.constantpool.LoadableConstantEntry.constantValue.

Doc from java.lang.classfile.constantpool.LoadableConstantEntry.constantValue.

Returns a symbolic descriptor of this constant.

This is equivalent to asSymbol().

Annotations

@Override

matches back to summary

matches	back to summary
public boolean matches(ClassDesc desc) Returns whether this entry describes the given reference type. Returns `false` if `desc` is primitive. Parameters desc:ClassDesc the reference type Returns:boolean whether this entry describes the given reference type Since 25

public boolean matches(ClassDesc desc)

Returns whether this entry describes the given reference type. Returns false if desc is primitive.

Parameters

desc:ClassDesc: the reference type

Returns:boolean

whether this entry describes the given reference type

Since

name back to summary

name	back to summary
public Utf8Entry name() Returns the `Utf8Entry` referred by this structure. If the value of the UTF8 starts with a `[`, this represents an array type and the value is a descriptor string; otherwise, this represents a class or interface and the value is the internal form of a binary name. Returns:Utf8Entry the `Utf8Entry` referred by this structure See Also `ConstantPoolBuilder::classEntry(Utf8Entry)`

public Utf8Entry name()

Returns the Utf8Entry referred by this structure. If the value of the UTF8 starts with a [, this represents an array type and the value is a descriptor string; otherwise, this represents a class or interface and the value is the internal form of a binary name.

Returns:Utf8Entry: the Utf8Entry referred by this structure
See Also: ConstantPoolBuilder::classEntry(Utf8Entry)

public sealed Interface ClassEntry

Method Summary

Method Detail