Module java.base

Package java.lang.constant

Interface ClassDesc

所有超级接口:

ConstantDesc, TypeDescriptor, TypeDescriptor.OfField<ClassDesc>

       public sealed interface ClassDesc extends ConstantDesc, TypeDescriptor.OfField<ClassDesc>
      

一个名义描述符，用于表示一个Class常量。

对于常见的系统类型，包括所有原始类型，ClassDesc在ConstantDescs中有预定义的常量。(在java.lang.constant API中，将void视为原始类型。)要为类或接口类型创建一个ClassDesc，请使用of(java.lang.String)或ofDescriptor(String)；要为数组类型创建一个ClassDesc，请使用ofDescriptor(String)，或先获取组件类型的ClassDesc，然后调用arrayType()或arrayType(int)方法。

自 JDK 版本:

12

参见:

• ConstantDescs

Nested Class Summary

Nested classes/interfaces declared in interface java.lang.invoke.TypeDescriptor

TypeDescriptor.OfField<F extends TypeDescriptor.OfField<F>>, TypeDescriptor.OfMethod<F extends TypeDescriptor.OfField<F>,M extends TypeDescriptor.OfMethod<F,M>>

Method Summary

Modifier and Type	Method	Description
default ClassDesc	arrayType()	返回一个由此ClassDesc描述其组件类型的数组类型的ClassDesc。
default ClassDesc	arrayType(int rank)	返回一个由此ClassDesc描述其组件类型的数组类型的指定等级的ClassDesc。
default ClassDesc	componentType()	如果描述的是数组类型，则返回此ClassDesc的组件类型；否则返回null。
String	descriptorString()	返回此类型的字段类型描述符字符串
default String	displayName()	返回此描述符描述的类型的人类可读名称。
boolean	equals(Object o)	将指定对象与此描述符进行比较以判断是否相等。
default boolean	isArray()	返回此ClassDesc是否描述一个数组类型。
default boolean	isClassOrInterface()	返回此ClassDesc是否描述一个类或接口类型。
default boolean	isPrimitive()	返回此ClassDesc是否描述一个原始类型。
default ClassDesc	nested(String nestedName)	返回此ClassDesc的类或接口类型描述的嵌套类的ClassDesc。
default ClassDesc	nested(String firstNestedName, String... moreNestedNames)	返回此ClassDesc的类或接口类型描述的嵌套类的ClassDesc。
static ClassDesc	of(String name)	返回一个给定类或接口名称的ClassDesc，例如"java.lang.String"。
static ClassDesc	of(String packageName, String className)	返回一个给定包名和类或接口的未限定（简单）名称的ClassDesc。
static ClassDesc	ofDescriptor(String descriptor)	给定一个类、接口、数组或原始类型的描述符字符串，返回一个ClassDesc。
static ClassDesc	ofInternalName(String name)	返回此ClassDesc的包名，如果描述的是类或接口类型。
default String	packageName()	反射地解析此描述符，模拟JVMS 5.4.3的解析行为和JVMS 5.4.4的访问控制行为。
Class<?>	resolveConstantDesc(MethodHandles.Lookup lookup)	返回一个给定类或接口名称的ClassDesc，例如"java.lang.String"。（要为数组类型创建一个描述符，可以使用ofDescriptor(String)或arrayType()；要为原始类型创建一个描述符，可以使用ofDescriptor(String)或使用ConstantDescs中的预定义常量。）

Method Details

of

             static ClassDesc of(String name)
            

Returns a ClassDesc for a class or interface type, given the name of the class or interface, such as "java.lang.String". (To create a descriptor for an array type, either use ofDescriptor(String) or arrayType(); to create a descriptor for a primitive type, use ofDescriptor(String) or use the predefined constants in ConstantDescs).

参数:

name - 完全限定（点分隔）的二进制类名

返回:

描述所需类的ClassDesc

抛出:

NullPointerException - 如果参数为null

IllegalArgumentException - 如果名称字符串格式不正确

参见:

• ofDescriptor(String)
• ofInternalName(String)

ofInternalName

             static ClassDesc ofInternalName(String name)
            

返回一个给定类或接口名称的ClassDesc，例如"java/lang/String"的内部形式。

API 注释:

要为数组类型创建一个描述符，可以使用ofDescriptor(String)或arrayType()；要为原始类型创建一个描述符，可以使用ofDescriptor(String)或使用ConstantDescs中的预定义常量。

参数:

name - 完全限定类名，以内部（斜杠分隔）形式表示

返回:

描述所需类的ClassDesc

抛出:

NullPointerException - 如果参数为null

IllegalArgumentException - 如果包名或类名的字符串格式不正确

参见Java虚拟机规范:

4.2.1 二进制类和接口名称

自 JDK 版本:

20

参见:

• of(String)
• ofDescriptor(String)

of

             static ClassDesc of(String packageName, String className)
            

返回一个给定包名和类或接口的未限定（简单）名称的ClassDesc。

参数:

packageName - 包名（点分隔）；如果包名为空字符串，则认为该类位于未命名包中

className - 未限定（简单）类名

返回:

描述所需类的ClassDesc

抛出:

NullPointerException - 如果任何参数为null

IllegalArgumentException - 如果包名或类名的格式不正确

ofDescriptor

             static ClassDesc ofDescriptor(String descriptor)
            

给定一个类、接口、数组或原始类型的描述符字符串，返回一个ClassDesc。

API 注释:

针对非数组类型的字段类型描述符字符串可以是一个对应于原始类型的单个字母代码（"J", "I", "C", "S", "B", "D", "F", "Z", "V"），或者是字母"L"，后跟类的完全限定二进制名称，后跟";"。数组类型的字段类型描述符是字符"["，后跟组件类型的字段描述符。有效类型描述符字符串的示例包括"Ljava/lang/String;"，"I"，"[I"，"V"，"[Ljava/lang/String;"等。有关更多详细信息，请参见JVMS 4.3.2 （"字段描述符"）。

参数:

descriptor - 字段描述符字符串

返回:

描述所需类的ClassDesc

抛出:

NullPointerException - 如果参数为null

IllegalArgumentException - 如果描述符字符串格式不正确

参见Java虚拟机规范:

4.3.2 字段描述符
4.4.1 CONSTANT_Class_info 结构

另请参阅:

• of(String)
• ofInternalName(String)

arrayType

             default ClassDesc arrayType()
            

返回一个ClassDesc，其组件类型由此ClassDesc描述。

指定者:

arrayType 在接口 TypeDescriptor.OfField<ClassDesc>

返回:

描述数组类型的ClassDesc

抛出:

IllegalStateException - 如果结果的ClassDesc的数组级别大于255

参见Java虚拟机规范:

4.4.1 CONSTANT_Class_info 结构

arrayType

             default ClassDesc arrayType(int rank)
            

返回一个ClassDesc，其组件类型由此ClassDesc描述的指定级别的数组类型。

参数:

rank - 数组的级别

返回:

描述数组类型的ClassDesc

抛出:

IllegalArgumentException - 如果级别小于或等于零，或者结果数组类型的级别大于255

参见Java虚拟机规范:

4.4.1 CONSTANT_Class_info 结构

nested

             default ClassDesc nested(String nestedName)
            

返回一个ClassDesc，用于描述由此ClassDesc描述的类或接口类型的嵌套类。

API 注释:

示例：如果描述符d描述类java.util.Map，则可以通过d.nested("Entry")获得类java.util.Map.Entry的描述符。

参数:

nestedName - 嵌套类的未限定名称

返回:

描述嵌套类的ClassDesc

抛出:

NullPointerException - 如果参数为null

IllegalStateException - 如果此ClassDesc不描述类或接口类型

IllegalArgumentException - 如果嵌套类名称无效

nested

             default ClassDesc nested(String firstNestedName, String... moreNestedNames)
            

返回一个ClassDesc，用于描述由此ClassDesc描述的类或接口类型的嵌套类。

参数:

firstNestedName - 第一级嵌套类的未限定名称

moreNestedNames - 剩余级别的嵌套类的未限定名称

返回:

描述嵌套类的ClassDesc

抛出:

NullPointerException - 如果任何参数或其内容为null

IllegalStateException - 如果此ClassDesc不描述类或接口类型

IllegalArgumentException - 如果嵌套类名称无效

isArray

             default boolean isArray()
            

返回此ClassDesc是否描述数组类型。

指定者:

isArray 在接口 TypeDescriptor.OfField<ClassDesc>

返回:

此ClassDesc是否描述数组类型

isPrimitive

             default boolean isPrimitive()
            

返回此ClassDesc是否描述原始类型。

指定者:

isPrimitive 在接口 TypeDescriptor.OfField<ClassDesc>

返回:

此ClassDesc是否描述原始类型

isClassOrInterface

             default boolean isClassOrInterface()
            

返回此ClassDesc是否描述类或接口类型。

返回:

此ClassDesc是否描述类或接口类型

componentType

             default ClassDesc componentType()
            

返回此ClassDesc的组件类型，如果描述数组类型，则返回null。

指定者:

componentType 在接口 TypeDescriptor.OfField<ClassDesc>

返回:

描述组件类型的ClassDesc，如果此描述符不描述数组类型，则返回null

packageName

             default String packageName()
            

返回此ClassDesc的包名，如果描述类或接口类型。

返回:

包名，如果类在默认包中则为空字符串，或者此ClassDesc不描述类或接口类型

displayName

             default String displayName()
            

返回由此描述符描述的类型的人类可读名称。

实现要求:

默认实现返回原始类型的简单名称（例如，int），类或接口类型的未限定类名，或者数组类型的显示名称，后跟适当数量的[]对。

返回:

人类可读名称

descriptorString

             String descriptorString()
            

返回此类型的字段类型描述符字符串。

指定者:

descriptorString 在接口 TypeDescriptor

返回:

描述符字符串

参见Java虚拟机规范:

4.3.2 字段描述符

resolveConstantDesc

             Class<?> resolveConstantDesc(MethodHandles.Lookup lookup) throws ReflectiveOperationException
            

从接口复制的描述: ConstantDesc

以反射方式解析此描述符，模拟JVMS 5.4.3的解析行为和JVMS 5.4.4的访问控制行为。解析和访问控制上下文由 MethodHandles.Lookup 参数提供。不执行结果值的缓存。

指定者：

resolveConstantDesc 在接口 ConstantDesc

参数：

lookup - 提供名称解析和访问控制上下文的 MethodHandles.Lookup

返回：

已解析的常量值

抛出：

ReflectiveOperationException - 如果在解析过程中无法反射解析类、方法或字段

equals

             boolean equals(Object o)
            

将指定对象与此描述符进行比较以确定是否相等。仅当指定对象也是 ClassDesc 并且两者描述相同类型时返回 true。

覆盖：

equals 在类 Object

参数：

o - 另一个对象

返回：

此描述符是否等于另一个对象

参见：

• Object.hashCode()
• HashMap