Интерфейс ProgramElementDoc

Все суперинтерфейсы:: Comparable<Object>, Doc

Все известные подинтерфейсы:: AnnotationTypeDoc, AnnotationTypeElementDoc, ClassDoc, ConstructorDoc, ExecutableMemberDoc, FieldDoc, MemberDoc, MethodDoc

@Deprecated(since="9",
            forRemoval=true)
public interface ProgramElementDoc
extends Doc

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Объявления в этом пакете заменены объявлениями в пакете jdk.javadoc.doclet. Дополнительную информацию см. в руководстве по миграции в документации по этому пакету.

Представляет элемент программы Java: класс, интерфейс, поле, конструктор или метод. Это абстрактный класс, обрабатывающий информацию, общую для этих элементов.

См. также:: MemberDoc, ClassDoc

Методы

Модификатор и тип	Метод	Описание
`AnnotationDesc[]`	`annotations()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Получить аннотации этого элемента программы.
`ClassDoc`	`containingClass()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Получить содержащий класс или интерфейс этого элемента программы.
`PackageDoc`	`containingPackage()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Получить пакет, в котором содержится этот элемент программы.
`boolean`	`isFinal()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот элемент программы является final.
`boolean`	`isPackagePrivate()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот элемент программы является package private.
`boolean`	`isPrivate()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот элемент программы является private.
`boolean`	`isProtected()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот элемент программы является protected.
`boolean`	`isPublic()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот элемент программы является public.
`boolean`	`isStatic()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Возвращает true, если этот элемент программы является static.
`String`	`modifiers()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Получить строку модификаторов.
`int`	`modifierSpecifier()`	Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии. Получить целое число спецификатора модификаторов.
`String`	`qualifiedName()`	Устаревший, подлежит удалению: Этот элемент 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

Методы

containingClass

ClassDoc containingClass()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Получить содержащий класс или интерфейс этого элемента программы.

Возвращает:: ClassDoc для содержащего класса или интерфейса этого элемента. Если это верхний уровень класса или интерфейса, вернуть null.

containingPackage

PackageDoc containingPackage()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Получить пакет, в котором содержится этот элемент программы.

Возвращает:: PackageDoc для пакета, содержащего этот элемент. Если в безымянном пакете, этот PackageDoc будет иметь имя "".

qualifiedName

String qualifiedName()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Получить полностью квалифицированное имя этого элемента программы. Например, для класса java.util.Hashtable, вернуть "java.util.Hashtable".

Для метода bar() в классе Foo в безымянном пакете, вернуть "Foo.bar".

Возвращает:: квалифицированное имя элемента программы в виде строки.

modifierSpecifier

int modifierSpecifier()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Получить целое число спецификатора модификаторов.

Возвращает:: Получить целое число спецификатора модификаторов.
См. также:: Modifier

modifiers

String modifiers()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Получить строку модификаторов. Например, для:

public abstract int foo() { ... }

вернуть "public abstract". Аннотации не включаются.

Возвращает:: "public abstract".

annotations

AnnotationDesc[] annotations()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Получить аннотации этого элемента программы. Возвращает пустой массив, если их нет.

Возвращает:: аннотации этого элемента программы.
С тех пор:: 1.5

isPublic

boolean isPublic()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Возвращает true, если этот элемент программы является public.

Возвращает:: true, если этот элемент программы является public.

isProtected

boolean isProtected()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Возвращает true, если этот элемент программы является protected.

Возвращает:: true, если этот элемент программы является protected.

isPrivate

boolean isPrivate()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Возвращает true, если этот элемент программы является private.

Возвращает:: true, если этот элемент программы является private.

isPackagePrivate

boolean isPackagePrivate()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Возвращает true, если этот элемент программы является package private.

Возвращает:: true, если этот элемент программы является package private.

isStatic

boolean isStatic()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Возвращает true, если этот элемент программы является static.

Возвращает:: true, если этот элемент программы является static.

isFinal

boolean isFinal()

Устаревший, подлежит удалению: Этот элемент API может быть удален в будущей версии.

Возвращает true, если этот элемент программы является final.

Возвращает:: true, если этот элемент программы является final.