Класс ClassDoc
- Все суперинтерфейсы:
-
Comparable<Object>,Doc,ProgramElementDoc,Type
- Все известные подинтерфейсы:
AnnotationTypeDoc
@Deprecated(since="9",
forRemoval=true)
public interface ClassDoc
extends ProgramElementDoc, Type jdk.javadoc.doclet. Дополнительную информацию см. в Руководстве по миграции в документации по этому пакету.Представляет класс или интерфейс Java и предоставляет доступ к информации о классе, комментариях и тегах класса, а также к членам класса. ClassDoc существует только в том случае, если он был обработан в этом запуске javadoc. Ссылки на классы, которые могут или не могут быть обработаны в этом запуске, обозначаются с помощью Type (который может быть преобразован в ClassDoc, если это возможно).
- С момента:
- 1.2
- См. также:
Type
Методы
| Модификатор и тип | Метод | Описание |
|---|---|---|
ConstructorDoc[] | constructors() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает включенные конструкторы в этом классе. |
ConstructorDoc[] | constructors(boolean filter) | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает конструкторы в этом классе, отфильтрованные по указанному варианту модификатора доступа. |
boolean | definesSerializableFields() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает true, если поля Serializable явно определены с помощью специального члена класса |
FieldDoc[] | enumConstants() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает константы перечисления, если это тип перечисления. |
FieldDoc[] | fields() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает включенные поля в этом классе или интерфейсе. |
FieldDoc[] | fields(boolean filter) | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает поля в этом классе или интерфейсе, отфильтрованные по указанному варианту модификатора доступа. |
ClassDoc | findClass(String className) | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Находит указанный класс или интерфейс в контексте этого документа класса. |
ClassDoc[] | importedClasses() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Объявления импорта являются деталями реализации, которые не должны быть показаны здесь. |
PackageDoc[] | importedPackages() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Объявления импорта являются деталями реализации, которые не должны быть показаны здесь. |
ClassDoc[] | innerClasses() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает включенные вложенные классы и интерфейсы в этом классе или интерфейсе. |
ClassDoc[] | innerClasses(boolean filter) | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает вложенные классы и интерфейсы в этом классе или интерфейсе, отфильтрованные по указанному варианту модификатора доступа. |
ClassDoc[] | interfaces() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает реализуемые интерфейсы этим классом или расширяемые интерфейсы этим интерфейсом. |
Type[] | interfaceTypes() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает реализуемые интерфейсы этим классом или расширяемые интерфейсы этим интерфейсом. |
boolean | isAbstract() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот класс является абстрактным. |
boolean | isExternalizable() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот класс реализует или интерфейс расширяет |
boolean | isSerializable() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот класс реализует или интерфейс расширяет |
MethodDoc[] | methods() | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает включенные методы в этом классе или интерфейсе. |
MethodDoc[] | methods(boolean filter) | Устаревшее, для удаления: Этот элемент API может быть удален в будущей версии. Возвращает методы в этом классе или интерфейсе, отфильтрованные по указанному варианту модификатора доступа. |
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()
Возвращает true, если этот класс абстрактный. Возвращает true для всех интерфейсов.
- Возвращает:
- true, если этот класс абстрактный. Возвращает true для всех интерфейсов.
isSerializable
boolean isSerializable()
Возвращает true, если этот класс реализует или интерфейс расширяет java.io.Serializable. Поскольку java.io.Externalizable расширяет java.io.Serializable, объекты Externalizable также являются Serializable.
- Возвращает:
- true, если этот класс реализует или интерфейс расширяет
java.io.Serializable.
isExternalizable
boolean isExternalizable()
Возвращает true, если этот класс реализует или интерфейс расширяет java.io.Externalizable.
- Возвращает:
- true, если этот класс реализует или интерфейс расширяет
java.io.Externalizable.
serializationMethods
MethodDoc[] serializationMethods()
Возвращает методы сериализации для этого класса или интерфейса.
- Возвращает:
- массив объектов MethodDoc, представляющих методы сериализации для этого класса или интерфейса.
serializableFields
FieldDoc[] serializableFields()
Возвращает поля Serializable этого класса или интерфейса.
Возвращает либо список полей по умолчанию, документированных тегом serial,
либо возвращает один FieldDoc для serialPersistentField члена. Должен быть тег serialField для каждого поля Serializable, определённого компонентом массива ObjectStreamField от serialPersistentField.
- Возвращает:
- массив объектов
FieldDocдля полей Serializable этого класса или интерфейса. - См. также:
-
definesSerializableFields(),SerialFieldTag
definesSerializableFields
boolean definesSerializableFields()
Возвращает true, если поля Serializable явно определены со специальным членом класса serialPersistentFields.
- Возвращает:
- true, если поля Serializable явно определены со специальным членом класса
serialPersistentFields. - См. также:
-
serializableFields(),SerialFieldTag
superclass
ClassDoc superclass()
Возвращает суперкласс этого класса. Возвращает null, если это интерфейс.
Этот метод не может обрабатывать некоторые конструкции типов дженериков. Вместо этого следует использовать метод superclassType .
- Возвращает:
- ClassDoc для суперкласса этого класса, null, если суперкласс отсутствует.
- См. также:
superclassType()
superclassType
Type superclassType()
Возвращает суперкласс этого класса. Возвращает null, если это интерфейс. Суперкласс представлен либо ClassDoc, либо ParametrizedType.
- Возвращает:
- суперкласс этого класса или null, если суперкласс отсутствует.
- С момента:
- 1.5
subclassOf
boolean subclassOf(ClassDoc cd)
Проверяет, является ли этот класс подклассом указанного класса. Если это интерфейс, возвращает false для всех классов, кроме java.lang.Object (мы должны сохранить это неожиданное поведение по соображениям совместимости).
- Параметры:
-
cd- кандидат в суперкласс. - Возвращает:
- true, если cd является суперклассом этого класса.
interfaces
ClassDoc[] interfaces()
Возвращает интерфейсы, реализуемые этим классом или расширяемые этим интерфейсом. Включает только непосредственно объявленные интерфейсы, а не унаследованные. Возвращает пустой массив, если интерфейсов нет.
Этот метод не может обрабатывать некоторые конструкции типов дженериков. Вместо этого следует использовать метод interfaceTypes .
- Возвращает:
- массив объектов ClassDoc, представляющих интерфейсы.
- См. также:
interfaceTypes()
interfaceTypes
Type[] interfaceTypes()
Возвращает интерфейсы, реализуемые этим классом или расширяемые этим интерфейсом. Включает только непосредственно объявленные интерфейсы, а не унаследованные. Возвращает пустой массив, если интерфейсов нет.
- Возвращает:
- массив интерфейсов, каждый из которых представлен
ClassDocилиParametrizedType. - С момента:
- 1.5
typeParameters
TypeVariable[] typeParameters()
Возвращает формальные параметры типа этого класса или интерфейса. Возвращает пустой массив, если их нет.
- Возвращает:
- формальные параметры типа этого класса или интерфейса.
- С момента:
- 1.5
typeParamTags
ParamTag[] typeParamTags()
Возвращает теги параметров типа этого класса или интерфейса. Возвращает пустой массив, если их нет.
- Возвращает:
- теги параметров типа этого класса или интерфейса.
- С момента:
- 1.5
fields
FieldDoc[] fields()
Возвращает включенные поля в этом классе или интерфейсе. Исключение констант перечислений, если это тип перечисления.
- Возвращает:
- массив объектов FieldDoc, представляющих включенные поля в этом классе или интерфейсе.
fields
FieldDoc[] fields(boolean filter)
Возвращает поля в этом классе или интерфейсе, отфильтрованные по указанному варианту модификатора доступа. Исключение констант перечислений, если это тип перечисления.
- Параметры:
-
filter- Укажите true, чтобы отфильтровать по указанному варианту модификатора доступа. Укажите false, чтобы включить все поля независимо от варианта модификатора доступа. - Возвращает:
- массив объектов FieldDoc, представляющих включенные поля в этом классе или интерфейсе.
enumConstants
FieldDoc[] enumConstants()
Возвращает константы перечисления, если это тип перечисления. Возвращает пустой массив, если констант перечисления нет или это не тип перечисления.
- Возвращает:
- константы перечисления, если это тип перечисления.
methods
MethodDoc[] methods()
Возвращает включенные методы в этом классе или интерфейсе. То же, что и methods(true).
- Возвращает:
- массив объектов MethodDoc, представляющих включенные методы в этом классе или интерфейсе. Не включает конструкторы или элементы типа аннотации.
methods
MethodDoc[] methods(boolean filter)
Возвращает методы в этом классе или интерфейсе, отфильтрованные по указанному варианту модификатора доступа. Не включает конструкторы или элементы типа аннотации.
- Параметры:
-
filter- Укажите true, чтобы отфильтровать по указанному варианту модификатора доступа. Укажите false, чтобы включить все методы независимо от варианта модификатора доступа. - Возвращает:
- массив объектов MethodDoc, представляющих включенные методы в этом классе или интерфейсе.
constructors
ConstructorDoc[] constructors()
Возвращает включенные конструкторы в этом классе. Возвращает массив, содержащий конструктор по умолчанию без аргументов, если другие конструкторы отсутствуют. Возвращает пустой массив, если это интерфейс.
- Возвращает:
- массив объектов ConstructorDoc, представляющих включенные конструкторы в этом классе.
constructors
ConstructorDoc[] constructors(boolean filter)
Возвращает конструкторы в этом классе, отфильтрованные по указанному варианту модификатора доступа. Возвращает массив, содержащий конструктор по умолчанию без аргументов, если другие конструкторы отсутствуют.
- Параметры:
-
filter- Укажите true, чтобы отфильтровать по указанному варианту модификатора доступа. Укажите false, чтобы включить все конструкторы независимо от варианта модификатора доступа. - Возвращает:
- массив объектов ConstructorDoc, представляющих включенные конструкторы в этом классе.
innerClasses
ClassDoc[] innerClasses()
Возвращает включенные вложенные классы и интерфейсы внутри этого класса или интерфейса. Это включает как статические, так и нестатические вложенные классы. (Этот метод должен был называться nestedClasses(), так как вложенные классы технически нестатические.) Анонимные и локальные классы или интерфейсы не включаются.
- Возвращает:
- массив объектов ClassDoc, представляющих включенные классы и интерфейсы, определённые в этом классе или интерфейсе.
innerClasses
ClassDoc[] innerClasses(boolean filter)
Возвращает вложенные классы и интерфейсы в этом классе или интерфейсе, отфильтрованные по указанному варианту доступа. Это включает как статические, так и нестатические вложенные классы. Анонимные и локальные классы не включаются.
- Параметры:
-
filter- Укажите true, чтобы отфильтровать по указанному варианту доступа. Укажите false, чтобы включить все вложенные классы независимо от варианта доступа. - Возвращает:
- отфильтрованный массив объектов ClassDoc, представляющий включённые классы и интерфейсы, определённые в этом классе или интерфейсе.
findClass
ClassDoc findClass(String className)
Находит указанный класс или интерфейс в контексте этого документа класса. Порядок поиска: 1) полное имя, 2) вложенный в этот класс или интерфейс, 3) в этом пакете, 4) в импортах класса, 5) в импортах пакета. Возвращает ClassDoc, если найден, null, если не найден.
- Параметры:
-
className- Укажите имя класса для поиска в виде строки. - Возвращает:
- ClassDoc, если найден, null, если не найден.
importedClasses
@Deprecated(since="9",
forRemoval=true)
ClassDoc[] importedClasses() Получает список классов и интерфейсов, объявленных как импортированные. Они называются "декларациями импорта одного типа" в Спецификации языка Java™.
- Возвращает:
- массив ClassDoc, представляющий импортированные классы.
importedPackages
@Deprecated(since="9",
forRemoval=true)
PackageDoc[] importedPackages() Получает список пакетов, объявленных как импортированные. Они называются "декларациями импорта по требованию" в Спецификации языка Java™.
- Возвращает:
- массив PackageDoc, представляющий импортированные пакеты.
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.javadoc/com/sun/javadoc/ClassDoc.html