Module jdk.javadoc

Interface ClassDoc

  • 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 package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.
    Represents a java class or interface and provides access to information about the class, the class's comment and tags, and the members of the class. A ClassDoc only exists if it was processed in this run of javadoc. References to classes which may or may not have been processed in this run are referred to using Type (which can be converted to ClassDoc, if possible).
    Since:
    1.2
    See Also:
    Type
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      ConstructorDoc[] constructors()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return included constructors in this class.
      ConstructorDoc[] constructors​(boolean filter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return constructors in this class, filtered to the specified access modifier option.
      boolean definesSerializableFields()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return true if Serializable fields are explicitly defined with the special class member serialPersistentFields.
      FieldDoc[] enumConstants()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the enum constants if this is an enum type.
      FieldDoc[] fields()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return included fields in this class or interface.
      FieldDoc[] fields​(boolean filter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return fields in this class or interface, filtered to the specified access modifier option.
      ClassDoc findClass​(String className)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Find the specified class or interface within the context of this class doc.
      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.
      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.
      ClassDoc[] innerClasses()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return included nested classes and interfaces within this class or interface.
      ClassDoc[] innerClasses​(boolean filter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return nested classes and interfaces within this class or interface filtered to the specified access modifier option.
      ClassDoc[] interfaces()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return interfaces implemented by this class or interfaces extended by this interface.
      Type[] interfaceTypes()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return interfaces implemented by this class or interfaces extended by this interface.
      boolean isAbstract()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return true if this class is abstract.
      boolean isExternalizable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return true if this class implements or interface extends java.io.Externalizable.
      boolean isSerializable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return true if this class implements or interface extends java.io.Serializable.
      MethodDoc[] methods()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return included methods in this class or interface.
      MethodDoc[] methods​(boolean filter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return methods in this class or interface, filtered to the specified access modifier option.
      FieldDoc[] serializableFields()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the Serializable fields of this class or interface.
      MethodDoc[] serializationMethods()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the serialization methods for this class or interface.
      boolean subclassOf​(ClassDoc cd)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Test whether this class is a subclass of the specified class.
      ClassDoc superclass()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the superclass of this class.
      Type superclassType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the superclass of this class.
      TypeVariable[] typeParameters()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the formal type parameters of this class or interface.
      ParamTag[] typeParamTags()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Return the type parameter tags of this class or interface.