Документ (API Doclet)

Все Суперинтерфейсы:

Сопоставимый <Объект>

Все Известные Подынтерфейсы:

AnnotationTypeDoc, AnnotationTypeElementDoc, ClassDoc, ConstructorDoc, ExecutableMemberDoc, FieldDoc, MemberDoc, MethodDoc, PackageDoc, ProgramElementDoc, RootDoc
```
public interface Doc
extends Comparable<Object>
```
Представляет конструкции языка Java (пакет, класс, конструктор, метод, поле), которые имеют комментарии и были обработаны этим выполнением javadoc. Все объекты Документа уникальны, то есть, они == сопоставимы.

С тех пор:

1.2

Сводка метода

Методы
Модификатор и Тип	Метод и Описание
`Строка`	`commentText()` Возвратите текст комментария для этого элемента документа.
`int`	`compareTo(Object obj)` Сравнивает этот объект документа с указанным объектом для порядка.
`Тег[]`	`firstSentenceTags()` Возвратите первое предложение комментария как массив тегов.
`Строка`	`getRawCommentText()` Возвратите полный необработанный текст комментария.
`Тег[]`	`inlineTags()` Возвратите комментарий как массив тегов.
`boolean`	`isAnnotationType()` Действительно ли этот элемент Документа является типом аннотации?
`boolean`	`isAnnotationTypeElement()` Действительно ли этот элемент Документа является элементом типа аннотации?
`boolean`	`isClass()` Действительно ли этот элемент Документа является классом (и не интерфейс или тип аннотации)?
`boolean`	`isConstructor()` Действительно ли этот элемент Документа является конструктором?
`boolean`	`isEnum()` Действительно ли этот элемент Документа является перечислимым типом?
`boolean`	`isEnumConstant()` Действительно ли этот элемент Документа является перечислимой константой?
`boolean`	`isError()` Действительно ли этот элемент Документа является ошибочным классом?
`boolean`	`isException()` Действительно ли этот элемент Документа является классом исключений?
`boolean`	`isField()` Действительно ли этот элемент Документа является полем (но не перечислимая константа)?
`boolean`	`isIncluded()` Возвратите true, если этот элемент Документа включается в набор результатов.
`boolean`	`isInterface()` Действительно ли этот элемент Документа является интерфейсом (но не тип аннотации)?
`boolean`	`isMethod()` Действительно ли этот элемент Документа является методом (но не конструктор или элемент типа аннотации)?
`boolean`	`isOrdinaryClass()` Действительно ли этот элемент Документа является обычным классом?
`Строка`	`name()` Возвращает неполностью определенное имя этого элемента Документа.
`SourcePosition`	`position()` Возвратите исходную позицию первой строки соответствующего объявления, или нуль, если никакая позиция не доступна.
`SeeTag[]`	`seeTags()` Возвратитесь видение также тегирует в этом элементе Документа.
`void`	`setRawCommentText(String rawDocumentation)` Установите полный необработанный текст комментария.
`Тег[]`	`tags()` Возвратите все теги в этом элементе Документа.
`Тег[]`	`tags(String tagname)` Возвратите теги указанного вида в этом элементе Документа.

- Деталь метода
  - commentText
```
String commentText()
```
    Возвратите текст комментария для этого элемента документа. Теги были удалены.
  - теги
```
Tag[] tags()
```
    Возвратите все теги в этом элементе Документа.
    
    Возвраты:
    массив Tag объекты, содержащие все, наклеивают этот элемент Документа.
  - теги
```
Tag[] tags(String tagname)
```
    Возвратите теги указанного вида в этом элементе Документа. Например, если 'у tagname' будет значение "@serial", то все теги в этом элементе Документа вида "@serial" будут возвращены.
    
    Параметры:
    tagname - имя вида тега, чтобы искать.
    
    Возвраты:
    массив Тега, содержащего все теги, чьи 'вид ()' соответствует 'tagname'.
  - seeTags
```
SeeTag[] seeTags()
```
    Возвратитесь видение также тегирует в этом элементе Документа.
    
    Возвраты:
    массив SeeTag, содержащего все теги @see.
  - inlineTags
```
Tag[] inlineTags()
```
    Возвратите комментарий как массив тегов. Включает встроенные теги (то есть {ссылка} теги), но не метки блока. Каждый раздел простого текста представляется как a Tag из доброго "текста". Встроенные теги представляются как a SeeTag из вида "@see" и имя "@link".
    
    Возвраты:
    массив Tags представление комментария
  - firstSentenceTags
```
Tag[] firstSentenceTags()
```
    Возвратите первое предложение комментария как массив тегов. Включает встроенные теги (то есть {ссылка} теги), но не метки блока. Каждый раздел простого текста представляется как a Tag из доброго "текста". Встроенные теги представляются как a SeeTag из вида "@see" и имя "@link".
    Если локаль является английским языком, первое предложение определяется правилами, описанными в Спецификации языка Java (первая версия): "Это предложение заканчивается в первый период, который сопровождается пробелом, вкладкой, или разделителем строки или в первом tagline.", кроме того, строка будет завершена блочными HTML-тэгами: <p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <час> <пред> или </пред>. Если локаль не будет английской, то конец предложения будет определен BreakIterator.getSentenceInstance(Locale).
    
    Возвраты:
    массив Tags представление первого предложения комментария
  - getRawCommentText
```
String getRawCommentText()
```
    Возвратите полный необработанный текст комментария. Теги включаются как текст. Используемый, главным образом, для хранилища и получают операции как интернализация.
  - setRawCommentText
```
void setRawCommentText(String rawDocumentation)
```
    Установите полный необработанный текст комментария. Теги включаются как текст. Используемый, главным образом, для хранилища и получают операции как интернализация.
  - имя
```
String name()
```
    Возвращает неполностью определенное имя этого элемента Документа.
    
    Возвраты:
    имя
  - compareTo
```
int compareTo(Object obj)
```
    Сравнивает этот объект документа с указанным объектом для порядка. Возвращает отрицательное целое число, нуль, или положительное целое число, поскольку этот объект документа является меньше чем, равный, или больше чем данный объект.
    Этот метод удовлетворяет Comparable интерфейс.
    
    Определенный:
    
    compareTo в интерфейсе Comparable<Object>
    
    Параметры:
    obj - Object быть сравненным.
    
    Возвраты:
    отрицательное целое число, нуль, или положительное целое число как этот Объект являются меньше чем, равный, или больше чем данный Объект.
    
    Броски:
    
    ClassCastException - тип указанного Объекта препятствует тому, чтобы это было по сравнению с этим Объектом.
  - isField
```
boolean isField()
```
    Действительно ли этот элемент Документа является полем (но не перечислимая константа)?
    
    Возвраты:
    истина, если это представляет поле
  - isEnumConstant
```
boolean isEnumConstant()
```
    Действительно ли этот элемент Документа является перечислимой константой?
    
    Возвраты:
    истина, если это представляет перечислимую константу
    С тех пор:
    
    1.5
  - isConstructor
```
boolean isConstructor()
```
    Действительно ли этот элемент Документа является конструктором?
    
    Возвраты:
    истина, если это представляет конструктора
  - isMethod
```
boolean isMethod()
```
    Действительно ли этот элемент Документа является методом (но не конструктор или элемент типа аннотации)?
    
    Возвраты:
    истина, если это представляет метод
  - isAnnotationTypeElement
```
boolean isAnnotationTypeElement()
```
    Действительно ли этот элемент Документа является элементом типа аннотации?
    
    Возвраты:
    истина, если это представляет элемент типа аннотации
    С тех пор:
    
    1.5
  - isInterface
```
boolean isInterface()
```
    Действительно ли этот элемент Документа является интерфейсом (но не тип аннотации)?
    
    Возвраты:
    истина, если это представляет интерфейс
  - isException
```
boolean isException()
```
    Действительно ли этот элемент Документа является классом исключений?
    
    Возвраты:
    истина, если это представляет исключение
  - isError
```
boolean isError()
```
    Действительно ли этот элемент Документа является ошибочным классом?
    
    Возвраты:
    истина, если это представляет ошибку
  - isEnum
```
boolean isEnum()
```
    Действительно ли этот элемент Документа является перечислимым типом?
    
    Возвраты:
    истина, если это представляет перечислимый тип
    С тех пор:
    
    1.5
  - isAnnotationType
```
boolean isAnnotationType()
```
    Действительно ли этот элемент Документа является типом аннотации?
    
    Возвраты:
    истина, если это представляет тип аннотации
    С тех пор:
    
    1.5
  - isOrdinaryClass
```
boolean isOrdinaryClass()
```
    Действительно ли этот элемент Документа является обычным классом? (то есть не интерфейс, тип аннотации, перечисление, исключение, или ошибка)?
    
    Возвраты:
    истина, если это представляет обычный класс
  - isClass
```
boolean isClass()
```
    Действительно ли этот элемент Документа является классом (и не интерфейс или тип аннотации)? Это включает обычные классы, перечисления, ошибки и исключения.
    
    Возвраты:
    истина, если это представляет класс
  - isIncluded
```
boolean isIncluded()
```
    Возвратите true, если этот элемент Документа включается в набор результатов.
  - позиция
```
SourcePosition position()
```
    Возвратите исходную позицию первой строки соответствующего объявления, или нуль, если никакая позиция не доступна. Конструктор по умолчанию возвращает нуль, потому что у этого нет никакого расположения в исходном файле.
    
    С тех пор:
    
    1.4

Представьте ошибку или функцию
Java является торговой маркой или зарегистрированной торговой маркой Oracle и/или его филиалов в US и других странах.
Авторское право © 1993, 2011, Oracle и/или его филиалы. 500 Oracle Parkway
Берега красного дерева, Калифорния 94065 США. Все права защищены.

Интерфейсный Документ

Сводка метода

Деталь метода

commentText

теги

теги

seeTags

inlineTags

firstSentenceTags

getRawCommentText

setRawCommentText

имя

compareTo

isField

isEnumConstant

isConstructor

isMethod

isAnnotationTypeElement

isInterface

isException

isError

isEnum

isAnnotationType

isOrdinaryClass

isClass

isIncluded

позиция