-
- All Superinterfaces:
-
Comparable<Object>
,Doc
,ProgramElementDoc
,Type
- All Known Subinterfaces:
-
AnnotationTypeDoc
@Deprecated(since="9", forRemoval=true) public interface ClassDoc extends ProgramElementDoc, Type
Deprecated, for removal: This API element is subject to removal in a future version.The declarations in this package have been superseded by those in the packagejdk.javadoc.doclet
. For more information, see the Migration Guide in the documentation for that package.表示java类或接口,并提供对类,类的注释和标记以及类成员的信息的访问。 只有在此次javadoc运行中处理ClassDoc才会存在。 对在此运行中可能已处理或未处理的类的引用是使用Type引用的(如果可能,可以将其转换为ClassDoc)。- 从以下版本开始:
- 1.2
- 另请参见:
-
Type
-
-
方法摘要
所有方法 实例方法 抽象方法 弃用的方法 变量和类型 方法 描述 ConstructorDoc[]
constructors()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回 此类中的included个构造函数。ConstructorDoc[]
constructors(boolean filter)
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类中的构造函数,过滤到指定的 access modifier option 。boolean
definesSerializableFields()
不推荐使用,要删除:此API元素将在以后的版本中删除。如果使用特殊类成员serialPersistentFields
显式定义Serializable字段,则返回true。FieldDoc[]
enumConstants()
不推荐使用,要删除:此API元素将在以后的版本中删除。如果这是枚举类型,则返回枚举常量。FieldDoc[]
字段()
不推荐使用,要删除:此API元素将在以后的版本中删除。FieldDoc[]
字段(boolean filter)
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或接口中的字段,过滤到指定的 access modifier option 。ClassDoc
findClass(String className)
不推荐使用,要删除:此API元素将在以后的版本中删除。在此类doc的上下文中查找指定的类或接口。ClassDoc[]
importedClasses()
不推荐使用,要删除:此API元素将在以后的版本中删除。导入声明是不应在此处公开的实现细节。PackageDoc[]
importedPackages()
不推荐使用,要删除:此API元素将在以后的版本中删除。导入声明是不应在此处公开的实现细节。ClassDoc[]
innerClasses()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回 included此类或接口中的嵌套类和接口。ClassDoc[]
innerClasses(boolean filter)
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或接口中的嵌套类和接口,过滤到指定的 access modifier option 。ClassDoc[]
interfaces()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或由此接口扩展的接口实现的接口。Type[]
interfaceTypes()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或由此接口扩展的接口实现的接口。boolean
isAbstract()
不推荐使用,要删除:此API元素将在以后的版本中删除。如果此类是抽象的,则返回true。boolean
isExternalizable()
不推荐使用,要删除:此API元素将在以后的版本中删除。如果此类实现或接口扩展为java.io.Externalizable
则返回true。boolean
isSerializable()
不推荐使用,要删除:此API元素将在以后的版本中删除。如果此类实现或接口扩展java.io.Serializable
则返回true。MethodDoc[]
methods()
不推荐使用,要删除:此API元素将在以后的版本中删除。MethodDoc[]
methods(boolean filter)
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或接口中的方法,过滤到指定的 access modifier option 。FieldDoc[]
serializableFields()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或接口的Serializable字段。MethodDoc[]
serializationMethods()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或接口的序列化方法。boolean
subclassOf(ClassDoc cd)
不推荐使用,要删除:此API元素将在以后的版本中删除。测试此类是否是指定类的子类。ClassDoc
superclass()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类的超类。Type
superclassType()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类的超类。TypeVariable[]
typeParameters()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或接口的正式类型参数。ParamTag[]
typeParamTags()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此类或接口的类型参数标记。-
声明方法的接口 com.sun.javadoc.Doc
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags
-
声明方法的接口 com.sun.javadoc.ProgramElementDoc
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
-
声明方法的接口 com.sun.javadoc.Type
asAnnotatedType, asAnnotationTypeDoc, asClassDoc, asParameterizedType, asTypeVariable, asWildcardType, dimension, getElementType, isPrimitive, qualifiedTypeName, simpleTypeName, toString, typeName
-
-
-
-
方法详细信息
-
isAbstract
boolean isAbstract()
Deprecated, for removal: This API element is subject to removal in a future version.如果此类是抽象的,则返回true。 对所有接口都返回true。- 结果
- 如果此类是抽象的,则为true。 对所有接口都返回true。
-
isSerializable
boolean isSerializable()
Deprecated, for removal: This API element is subject to removal in a future version.如果此类实现或接口扩展java.io.Serializable
则返回true。 由于java.io.Externalizable
扩展为java.io.Serializable
,因此Externalizable对象也是可序列化的。- 结果
-
如果此类实现或接口扩展为
java.io.Serializable
。
-
isExternalizable
boolean isExternalizable()
Deprecated, for removal: This API element is subject to removal in a future version.如果此类实现或接口扩展java.io.Externalizable
则返回true。- 结果
-
如果此类实现或接口扩展
java.io.Externalizable
。
-
serializationMethods
MethodDoc[] serializationMethods()
Deprecated, for removal: This API element is subject to removal in a future version.返回此类或接口的序列化方法。- 结果
- 一组MethodDoc对象,表示此类或接口的序列化方法。
-
serializableFields
FieldDoc[] serializableFields()
Deprecated, for removal: This API element is subject to removal in a future version.返回此类或接口的Serializable字段。返回
serial
标记记录的默认字段列表
或返回单个FieldDoc
为serialPersistentField
构件。 对于ObjectStreamField
阵列组件serialPersistentField
定义的每个Serializable字段,应该有一个serialField
标记。- 结果
-
此类或接口的Serializable字段的
FieldDoc
对象数组。 - 另请参见:
-
definesSerializableFields()
,SerialFieldTag
-
definesSerializableFields
boolean definesSerializableFields()
Deprecated, for removal: This API element is subject to removal in a future version.如果使用特殊类成员serialPersistentFields
显式定义Serializable字段,则返回true。- 结果
-
如果使用特殊类成员
serialPersistentFields
显式定义Serializable字段,serialPersistentFields
。 - 另请参见:
-
serializableFields()
,SerialFieldTag
-
superclass
ClassDoc superclass()
Deprecated, for removal: This API element is subject to removal in a future version.返回此类的超类。 如果这是一个接口,则返回null。此方法无法容纳某些泛型类型构造。 应该使用
superclassType
方法。- 结果
- 此类的超类的ClassDoc,如果没有超类,则为null。
- 另请参见:
-
superclassType()
-
superclassType
Type superclassType()
Deprecated, for removal: This API element is subject to removal in a future version.返回此类的超类。 如果这是一个接口,则返回null。 超类由ClassDoc
或ParametrizedType
。- 结果
- 此类的超类,如果没有超类,则返回null。
- 从以下版本开始:
- 1.5
-
subclassOf
boolean subclassOf(ClassDoc cd)
Deprecated, for removal: This API element is subject to removal in a future version.测试此类是否是指定类的子类。 如果这是一个接口,则为除java.lang.Object
之外的所有类返回false(出于兼容性原因,我们必须保留此意外行为)。- 参数
-
cd
- 候选超类。 - 结果
- 如果cd是此类的超类,则为true。
-
interfaces
ClassDoc[] interfaces()
Deprecated, for removal: This API element is subject to removal in a future version.返回此类或由此接口扩展的接口实现的接口。 仅包含直接声明的接口,而不包括继承的接口。 如果没有接口,则返回一个空数组。此方法无法容纳某些泛型类型构造。 应该使用
interfaceTypes
方法。- 结果
- 表示接口的ClassDoc对象数组。
- 另请参见:
-
interfaceTypes()
-
interfaceTypes
Type[] interfaceTypes()
Deprecated, for removal: This API element is subject to removal in a future version.返回此类或由此接口扩展的接口实现的接口。 仅包含直接声明的接口,而不包括继承的接口。 如果没有接口,则返回一个空数组。- 结果
-
接口数组,每个接口由
ClassDoc
或ParametrizedType
。 - 从以下版本开始:
- 1.5
-
typeParameters
TypeVariable[] typeParameters()
Deprecated, for removal: This API element is subject to removal in a future version.返回此类或接口的正式类型参数。 如果没有,则返回一个空数组。- 结果
- 此类或接口的正式类型参数。
- 从以下版本开始:
- 1.5
-
typeParamTags
ParamTag[] typeParamTags()
Deprecated, for removal: This API element is subject to removal in a future version.返回此类或接口的类型参数标记。 如果没有,则返回一个空数组。- 结果
- 此类或接口的类型参数标记。
- 从以下版本开始:
- 1.5
-
字段
FieldDoc[] fields()
Deprecated, for removal: This API element is subject to removal in a future version.- 结果
- 一个FieldDoc对象数组,表示此类或接口中包含的字段。
-
字段
FieldDoc[] fields(boolean filter)
Deprecated, for removal: This API element is subject to removal in a future version.返回此类或接口中的字段,过滤到指定的access modifier option 。 如果这是枚举类型,则排除枚举常量。- 参数
-
filter
- 指定true以根据指定的访问修饰符选项进行筛选。 指定false以包括所有字段,而不管访问修饰符选项如何。 - 结果
- 一个FieldDoc对象数组,表示此类或接口中包含的字段。
-
enumConstants
FieldDoc[] enumConstants()
Deprecated, for removal: This API element is subject to removal in a future version.如果这是枚举类型,则返回枚举常量。 如果没有枚举常量,或者这不是枚举类型,则返回一个空数组。- 结果
- 枚举常量,如果这是枚举类型。
-
methods
MethodDoc[] methods()
Deprecated, for removal: This API element is subject to removal in a future version.- 结果
- 一个MethodDoc对象数组,表示此类或接口中包含的方法。 不包含构造函数或注释类型元素。
-
methods
MethodDoc[] methods(boolean filter)
Deprecated, for removal: This API element is subject to removal in a future version.返回此类或接口中的方法,过滤到指定的access modifier option 。 不包含构造函数或注释类型元素。- 参数
-
filter
- 指定true以根据指定的访问修饰符选项进行筛选。 指定false以包括所有方法,而不管访问修饰符选项如何。 - 结果
- 一个MethodDoc对象数组,表示此类或接口中包含的方法。
-
constructors
ConstructorDoc[] constructors()
Deprecated, for removal: This API element is subject to removal in a future version.- 结果
- 一个ConstructorDoc对象数组,表示此类中包含的构造函数。
-
constructors
ConstructorDoc[] constructors(boolean filter)
Deprecated, for removal: This API element is subject to removal in a future version.返回此类中的构造函数,过滤到指定的access modifier option 。 如果不存在其他构造函数,则返回包含缺省无参数构造函数的数组。- 参数
-
filter
- 指定true以根据指定的访问修饰符选项进行筛选。 指定false以包括所有构造函数,而不管访问修饰符选项如何。 - 结果
- 一个ConstructorDoc对象数组,表示此类中包含的构造函数。
-
innerClasses
ClassDoc[] innerClasses()
Deprecated, for removal: This API element is subject to removal in a future version.- 结果
- 一个ClassDoc对象数组,表示此类或接口中定义的包含的类和接口。
-
innerClasses
ClassDoc[] innerClasses(boolean filter)
Deprecated, for removal: This API element is subject to removal in a future version.- 参数
-
filter
- 指定true以根据指定的访问修饰符选项进行筛选。 指定false以包括所有嵌套类,而不管访问修饰符选项如何。 - 结果
- 过滤的ClassDoc对象数组,表示此类或接口中定义的包含的类和接口。
-
findClass
ClassDoc findClass(String className)
Deprecated, for removal: This API element is subject to removal in a future version.在此类doc的上下文中查找指定的类或接口。 搜索顺序:1)限定名称,2)嵌套在此类或接口中,3)在此包中,4)在类导入,5)在包导入中。 如果找到则返回ClassDoc,如果未找到则返回null。- 参数
-
className
- 指定要作为String查找的类名。 - 结果
- 找到ClassDoc,如果找不到则返回null。
-
importedClasses
@Deprecated(since="9", forRemoval=true) ClassDoc[] importedClasses()
Deprecated, for removal: This API element is subject to removal in a future version.Import declarations are implementation details that should not be exposed here. In addition, not all imported classes are imported through single-type-import declarations.获取声明为已导入的类和接口的列表。 这些在The Java™ Language Specification中称为“单一类型导入声明”。- 结果
- 表示导入类的ClassDoc数组。
-
importedPackages
@Deprecated(since="9", forRemoval=true) PackageDoc[] importedPackages()
Deprecated, for removal: This API element is subject to removal in a future version.Import declarations are implementation details that should not be exposed here. In addition, this method's return type does not allow for all type-import-on-demand declarations to be returned.获取声明为已导入的包列表。 这些在The Java™ Language Specification中称为“按需输入类型声明”。- 结果
- 一组PackageDoc,表示导入的包。
-
-