Module  jdk.javadoc
软件包  com.sun.javadoc

Interface ClassDoc

  • All Superinterfaces:
    Comparable<Object>DocProgramElementDocType
    All Known Subinterfaces:
    AnnotationTypeDoc

    已过时。
    该包中的声明已被包装jdk.javadoc.doclet的声明所取代。 有关详细信息,请参阅该软件包的文档中的“ 迁移指南”

    @Deprecated
    public interface ClassDoc
    extends ProgramElementDoc, Type
    表示一个java类或接口,并提供对类的信息,类的注释和标签以及类的成员的访问。 如果在此运行javadoc中处理了ClassDoc,则仅存在ClassDoc。 在本次运行中可能已经或可能未被处理过的类的引用使用Type(如果可能的话可以转换为ClassDoc)。
    从以下版本开始:
    1.2
    另请参见:
    Type
    • 方法详细信息

      • isAbstract

        boolean isAbstract​()
        已过时。
        如果这个类是抽象的,返回true。 为所有接口返回true。
        结果
        如果这个类是抽象的,则为true。 为所有接口返回true。
      • isSerializable

        boolean isSerializable​()
        已过时。
        如果这个类实现或者接口扩展,返回true java.io.Serializable 由于java.io.Externalizable扩展了java.io.Serializable ,Externalizable对象也是Serializable。
        结果
        如果此类实现或接口扩展, java.io.Serializable
      • isExternalizable

        boolean isExternalizable​()
        已过时。
        如果这个类实现或者接口扩展,返回true java.io.Externalizable
        结果
        如果此类实现或接口扩展, java.io.Externalizable
      • serializationMethods

        MethodDoc[] serializationMethods​()
        已过时。
        返回此类或接口的序列化方法。
        结果
        MethodDoc对象数组,表示此类或接口的序列化方法。
      • serializableFields

        FieldDoc[] serializableFields​()
        已过时。
        返回此类或接口的Serializable字段。

        返回由serial标记记录的默认字段列表
        或返回一个FieldDocserialPersistentField成员。 每个可序列化字段应该有一个serialField标记,由ObjectStreamField阵列组件serialPersistentField

        结果
        一个 FieldDoc对象的数组,用于此类或接口的可序列化字段。
        另请参见:
        definesSerializableFields()SerialFieldTag
      • definesSerializableFields

        boolean definesSerializableFields​()
        已过时。
        如果使用特殊类成员 serialPersistentFields显式定义可序列化字段,则返回true。
        结果
        如果使用特殊类成员 serialPersistentFields显式定义可序列化字段, serialPersistentFields
        另请参见:
        serializableFields()SerialFieldTag
      • superclass

        ClassDoc superclass​()
        已过时。
        返回此类的超类。 如果这是一个接口,则返回null。

        此方法无法适应某些通用类型的构造。 应该使用superclassType方法。

        结果
        这个类的超类的ClassDoc,如果没有超类,则为null。
        另请参见:
        superclassType()
      • superclassType

        Type superclassType​()
        已过时。
        返回此类的超类。 如果这是一个接口,则返回null。 超类由ClassDocParametrizedType
        结果
        这个类的超类,如果没有超类,则为null。
        从以下版本开始:
        1.5
      • subclassOf

        boolean subclassOf​(ClassDoc cd)
        已过时。
        测试这个类是否是指定类的子类。 如果这是一个接口,对于除了java.lang.Object之外的所有类,返回false(为了兼容性原因,我们必须保留这个意外的行为)。
        参数
        cd - 候选超类。
        结果
        如果cd是这个类的超类,则为true。
      • interfaces

        ClassDoc[] interfaces​()
        已过时。
        返回由此类实现的接口或此接口扩展的接口。 只包括直接声明的接口,而不是继承接口。 如果没有接口,返回一个空数组。

        此方法无法适应某些通用类型的构造。 应该使用interfaceTypes方法。

        结果
        表示接口的ClassDoc对象数组。
        另请参见:
        interfaceTypes()
      • interfaceTypes

        Type[] interfaceTypes​()
        已过时。
        返回由此类实现的接口或此接口扩展的接口。 只包括直接声明的接口,而不是继承接口。 如果没有接口,返回一个空数组。
        结果
        接口阵列,每一个由 ClassDocParametrizedType
        从以下版本开始:
        1.5
      • typeParameters

        TypeVariable[] typeParameters​()
        已过时。
        返回此类或接口的形式类型参数。 如果没有,返回一个空数组。
        结果
        该类或接口的正式类型参数。
        从以下版本开始:
        1.5
      • typeParamTags

        ParamTag[] typeParamTags​()
        已过时。
        返回此类或接口的类型参数标签。 如果没有,返回一个空数组。
        结果
        该类或接口的类型参数标签。
        从以下版本开始:
        1.5
      • fields

        FieldDoc[] fields​()
        已过时。
        返回此类或接口中的included字段。 如果这是枚举类型,则排除枚举常量。
        结果
        表示此类或接口中包含的字段的FieldDoc对象数组。
      • fields

        FieldDoc[] fields​(boolean filter)
        已过时。
        返回此类或接口中的字段,过滤到指定的access modifier option 如果这是枚举类型,则排除枚举常量。
        参数
        filter - 根据指定的访问修饰符选项指定true进行过滤。 指定false以包括所有字段,而不考虑访问修饰符选项。
        结果
        表示此类或接口中包含的字段的FieldDoc对象数组。
      • enumConstants

        FieldDoc[] enumConstants​()
        已过时。
        如果这是枚举类型,则返回枚举常量。 如果没有枚举常量,或者这不是枚举类型,则返回一个空数组。
        结果
        枚举常量,如果这是一个枚举类型。
      • methods

        MethodDoc[] methods​()
        已过时。
        返回此类或接口中的included方法。 methods(true)相同。
        结果
        表示此类或接口中包含的方法的MethodDoc对象数组。 不包括构造函数或注释类型元素。
      • methods

        MethodDoc[] methods​(boolean filter)
        已过时。
        返回此类或接口中的方法,过滤到指定的access modifier option 不包括构造函数或注释类型元素。
        参数
        filter - 根据指定的访问修饰符选项指定true进行过滤。 指定false以包括所有方法,而不考虑访问修饰符选项。
        结果
        表示此类或接口中包含的方法的MethodDoc对象数组。
      • constructors

        ConstructorDoc[] constructors​()
        已过时。
        在此类中返回included构造函数。 如果没有其他构造函数存在,则返回包含默认无参构造函数的数组。 如果这是一个接口,返回空数组。
        结果
        一组ConstructorDoc对象,表示此类中包含的构造函数。
      • constructors

        ConstructorDoc[] constructors​(boolean filter)
        已过时。
        在此类中返回构造函数,过滤到指定的access modifier option 如果没有其他构造函数存在,返回一个包含默认的无参数构造函数的数组。
        参数
        filter - 根据指定的访问修饰符选项指定true进行过滤。 指定false以包含所有构造函数,而不管访问修饰符选项如何。
        结果
        一组ConstructorDoc对象,表示此类中包含的构造函数。
      • innerClasses

        ClassDoc[] innerClasses​()
        已过时。
        返回included此类或接口中的嵌套类和接口。 这包括静态和非静态嵌套类。 (这种方法应该被命名为nestedClasses() ,因为内部类在技术上是非静态的。)不包括匿名和本地类或接口。
        结果
        一组ClassDoc对象,表示在此类或接口中定义的包含的类和接口。
      • innerClasses

        ClassDoc[] innerClasses​(boolean filter)
        已过时。
        返回此类或接口中的嵌套类和接口,过滤到指定的access modifier option 这包括静态和非静态嵌套类。 不包括匿名和本地课程。
        参数
        filter - 根据指定的访问修饰符选项指定true进行过滤。 指定false以包括所有嵌套类,而不考虑访问修饰符选项。
        结果
        一个过滤的ClassDoc对象数组,表示在此类或接口中定义的包含的类和接口。
      • findClass

        ClassDoc findClass​(String className)
        已过时。
        在该类doc的上下文中找到指定的类或接口。 搜索顺序:1)限定名称,2)嵌套在此类或接口中,3)在此包中,4)在类中导入,5)在包导入中。 如果找到,返回ClassDoc,如果找不到则返回null。
        参数
        className - 指定要以String形式查找的类名。
        结果
        如果找到ClassDoc,如果找不到则为null。
      • importedClasses

        @Deprecated
        ClassDoc[] importedClasses​()
        已过时。 导入声明是不应该在这里公开的实现细节。 另外,并不是所有导入的类都是通过单一类型导入的声明导入的。
        获取声明为导入的类和接口的列表。 这些在The Java™ Language Specification中称为“单一类型导入声明”。
        结果
        一个代表导入类的ClassDoc数组。
      • importedPackages

        @Deprecated
        PackageDoc[] importedPackages​()
        已过时。 导入声明是不应该在这里公开的实现细节。 此外,此方法的返回类型不允许返回所有类型导入按需的声明。
        获取声明为导入的包的列表。 这些在The Java™ Language Specification中称为“类型导入按需申报”。
        结果
        一个PackageDoc数组,表示导入的包。