- 
- All Superinterfaces:
- Comparable<Object>
 - All Known Subinterfaces:
- AnnotationTypeDoc,- AnnotationTypeElementDoc,- ClassDoc,- ConstructorDoc,- ExecutableMemberDoc,- FieldDoc,- MemberDoc,- MethodDoc,- PackageDoc,- ProgramElementDoc,- RootDoc
 
 @Deprecated(since="9", forRemoval=true) public interface Doc extends Comparable<Object> 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 packagejdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.Represents Java language constructs (package, class, constructor, method, field) which have comments and have been processed by this run of javadoc. All Doc objects are unique, that is, they are == comparable.- Since:
- 1.2
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description StringcommentText()Deprecated, for removal: This API element is subject to removal in a future version.Return the text of the comment for this doc item.intcompareTo(Object obj)Deprecated, for removal: This API element is subject to removal in a future version.Compares this doc object with the specified object for order.Tag[]firstSentenceTags()Deprecated, for removal: This API element is subject to removal in a future version.Return the first sentence of the comment as an array of tags.StringgetRawCommentText()Deprecated, for removal: This API element is subject to removal in a future version.Return the full unprocessed text of the comment.Tag[]inlineTags()Deprecated, for removal: This API element is subject to removal in a future version.Return comment as an array of tags.booleanisAnnotationType()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an annotation type?booleanisAnnotationTypeElement()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an annotation type element?booleanisClass()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item a class (and not an interface or annotation type)?booleanisConstructor()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item a constructor?booleanisEnum()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an enum type?booleanisEnumConstant()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an enum constant?booleanisError()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an error class?booleanisException()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an exception class?booleanisField()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item a field (but not an enum constant)?booleanisIncluded()Deprecated, for removal: This API element is subject to removal in a future version.Return true if this Doc item is included in the result set.booleanisInterface()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an interface (but not an annotation type)?booleanisMethod()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item a method (but not a constructor or annotation type element)?booleanisOrdinaryClass()Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an ordinary class?Stringname()Deprecated, for removal: This API element is subject to removal in a future version.Returns the non-qualified name of this Doc item.SourcePositionposition()Deprecated, for removal: This API element is subject to removal in a future version.Return the source position of the first line of the corresponding declaration, or null if no position is available.SeeTag[]seeTags()Deprecated, for removal: This API element is subject to removal in a future version.Return the see also tags in this Doc item.voidsetRawCommentText(String rawDocumentation)Deprecated, for removal: This API element is subject to removal in a future version.Set the full unprocessed text of the comment.Tag[]tags()Deprecated, for removal: This API element is subject to removal in a future version.Return all tags in this Doc item.Tag[]tags(String tagname)Deprecated, for removal: This API element is subject to removal in a future version.Return tags of the specified kind in this Doc item.
 
- 
- 
- 
Method Detail- 
commentTextString commentText() Deprecated, for removal: This API element is subject to removal in a future version.Return the text of the comment for this doc item. Tags have been removed.- Returns:
- the text of the comment for this doc item.
 
 - 
tagsTag[] tags() Deprecated, for removal: This API element is subject to removal in a future version.Return all tags in this Doc item.- Returns:
- an array of Tagobjects containing all tags on this Doc item.
 
 - 
tagsTag[] tags(String tagname) Deprecated, for removal: This API element is subject to removal in a future version.Return tags of the specified kind in this Doc item. For example, if 'tagname' has value "@serial", all tags in this Doc item of kind "@serial" will be returned.- Parameters:
- tagname- name of the tag kind to search for.
- Returns:
- an array of Tag containing all tags whose 'kind()' matches 'tagname'.
 
 - 
seeTagsSeeTag[] seeTags() Deprecated, for removal: This API element is subject to removal in a future version.Return the see also tags in this Doc item.- Returns:
- an array of SeeTag containing all @see tags.
 
 - 
inlineTagsTag[] inlineTags() Deprecated, for removal: This API element is subject to removal in a future version.Return comment as an array of tags. Includes inline tags (i.e. {@link reference} tags) but not block tags. Each section of plain text is represented as aTagof kind "Text". Inline tags are represented as aSeeTagof kind "@see" and name "@link".- Returns:
- an array of Tags representing the comment
 
 - 
firstSentenceTagsTag[] firstSentenceTags() Deprecated, for removal: This API element is subject to removal in a future version.Return the first sentence of the comment as an array of tags. Includes inline tags (i.e. {@link reference} tags) but not block tags. Each section of plain text is represented as aTagof kind "Text". Inline tags are represented as aSeeTagof kind "@see" and name "@link".If the locale is English language, the first sentence is determined by the rules described in the Java Language Specification (first version): "This sentence ends at the first period that is followed by a blank, tab, or line terminator or at the first tagline.", in addition a line will be terminated by block HTML tags: <p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre> or </pre>. If the locale is not English, the sentence end will be determined by BreakIterator.getSentenceInstance(Locale).- Returns:
- an array of Tags representing the first sentence of the comment
 
 - 
getRawCommentTextString getRawCommentText() Deprecated, for removal: This API element is subject to removal in a future version.Return the full unprocessed text of the comment. Tags are included as text. Used mainly for store and retrieve operations like internalization.- Returns:
- the full unprocessed text of the comment.
 
 - 
setRawCommentTextvoid setRawCommentText(String rawDocumentation) Deprecated, for removal: This API element is subject to removal in a future version.Set the full unprocessed text of the comment. Tags are included as text. Used mainly for store and retrieve operations like internalization.- Parameters:
- rawDocumentation- A String containing the full unprocessed text of the comment.
 
 - 
nameString name() Deprecated, for removal: This API element is subject to removal in a future version.Returns the non-qualified name of this Doc item.- Returns:
- the name
 
 - 
compareToint compareTo(Object obj) Deprecated, for removal: This API element is subject to removal in a future version.Compares this doc object with the specified object for order. Returns a negative integer, zero, or a positive integer as this doc object is less than, equal to, or greater than the given object.This method satisfies the Comparableinterface.- Specified by:
- compareToin interface- Comparable<Object>
- Parameters:
- obj- the- Objectto be compared.
- Returns:
- a negative integer, zero, or a positive integer as this Object is less than, equal to, or greater than the given Object.
- Throws:
- ClassCastException- the specified Object's type prevents it from being compared to this Object.
 
 - 
isFieldboolean isField() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item a field (but not an enum constant)?- Returns:
- true if it represents a field
 
 - 
isEnumConstantboolean isEnumConstant() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an enum constant?- Returns:
- true if it represents an enum constant
- Since:
- 1.5
 
 - 
isConstructorboolean isConstructor() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item a constructor?- Returns:
- true if it represents a constructor
 
 - 
isMethodboolean isMethod() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item a method (but not a constructor or annotation type element)?- Returns:
- true if it represents a method
 
 - 
isAnnotationTypeElementboolean isAnnotationTypeElement() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an annotation type element?- Returns:
- true if it represents an annotation type element
- Since:
- 1.5
 
 - 
isInterfaceboolean isInterface() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an interface (but not an annotation type)?- Returns:
- true if it represents an interface
 
 - 
isExceptionboolean isException() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an exception class?- Returns:
- true if it represents an exception
 
 - 
isErrorboolean isError() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an error class?- Returns:
- true if it represents a error
 
 - 
isEnumboolean isEnum() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an enum type?- Returns:
- true if it represents an enum type
- Since:
- 1.5
 
 - 
isAnnotationTypeboolean isAnnotationType() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an annotation type?- Returns:
- true if it represents an annotation type
- Since:
- 1.5
 
 - 
isOrdinaryClassboolean isOrdinaryClass() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item an ordinary class? (i.e. not an interface, annotation type, enum, exception, or error)?- Returns:
- true if it represents an ordinary class
 
 - 
isClassboolean isClass() Deprecated, for removal: This API element is subject to removal in a future version.Is this Doc item a class (and not an interface or annotation type)? This includes ordinary classes, enums, errors and exceptions.- Returns:
- true if it represents a class
 
 - 
isIncludedboolean isIncluded() Deprecated, for removal: This API element is subject to removal in a future version.Return true if this Doc item is included in the result set.- Returns:
- true if this Doc item is included in the result set.
 
 - 
positionSourcePosition position() Deprecated, for removal: This API element is subject to removal in a future version.Return the source position of the first line of the corresponding declaration, or null if no position is available. A default constructor returns null because it has no location in the source file.- Returns:
- the source positino of the first line of the corresponding declaration, or null if no position is available. A default constructor returns null because it has no location in the source file.
- Since:
- 1.4
 
 
- 
 
-