Class DocImpl
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
-
- All Implemented Interfaces:
Doc
,Comparable<Object>
- Direct Known Subclasses:
PackageDocImpl
,ProgramElementDocImpl
,RootDocImpl
@Deprecated public abstract class DocImpl extends Object implements Doc, Comparable<Object>
Deprecated.abstract base class of all Doc classes. Doc item's are representations of java language constructs (class, package, method,...) which have comments and have been processed by this run of javadoc. All Doc items are unique, that is, they are == comparable.This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.2
- Author:
- Robert Field, Atul M Dambalkar, Neal Gafter (rewrite)
-
-
Field Summary
Fields Modifier and Type Field Description protected String
documentation
Deprecated.Raw documentation string.protected DocEnv
env
Deprecated.Doc environmentprotected com.sun.source.util.TreePath
treePath
Deprecated.Back pointer to the tree node for this doc item.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
commentText()
Deprecated.Return the text of the comment for this doc item.int
compareTo(Object obj)
Deprecated.Compares this Object with the specified Object for order.protected String
documentation()
Deprecated.So subclasses have the option to do lazy initialization of "documentation" string.Tag[]
firstSentenceTags()
Deprecated.Return the first sentence of the comment as an array of tags.String
getRawCommentText()
Deprecated.Return the full unprocessed text of the comment.Tag[]
inlineTags()
Deprecated.Return comment as an array of tags.boolean
isAnnotationType()
Deprecated.Is this Doc item an annotation type? False until overridden.boolean
isAnnotationTypeElement()
Deprecated.Is this Doc item an annotation type element? False until overridden.boolean
isClass()
Deprecated.Is this Doc item a class (and not an interface or annotation type)? This includes ordinary classes, enums, errors and exceptions.boolean
isConstructor()
Deprecated.Is this Doc item a constructor? False until overridden.boolean
isEnum()
Deprecated.Is this Doc item an enum type? False until overridden.boolean
isEnumConstant()
Deprecated.Is this Doc item an enum constant? False until overridden.boolean
isError()
Deprecated.Is this Doc item a error class? False until overridden.boolean
isException()
Deprecated.Is this Doc item a exception class? False until overridden.boolean
isField()
Deprecated.Is this Doc item a field? False until overridden.abstract boolean
isIncluded()
Deprecated.return true if this Doc is include in the active set.boolean
isInterface()
Deprecated.Is this Doc item a interface (but not an annotation type)? False until overridden.boolean
isMethod()
Deprecated.Is this Doc item a method (but not a constructor or annotation type element)? False until overridden.boolean
isOrdinaryClass()
Deprecated.Is this Doc item an ordinary class (i.e.abstract String
name()
Deprecated.Returns the name of this Doc item.SourcePosition
position()
Deprecated.Return the source position of the entity, or null if no position is available.abstract String
qualifiedName()
Deprecated.Returns the qualified name of this Doc item.SeeTag[]
seeTags()
Deprecated.Return the see also tags in this Doc item.void
setRawCommentText(String rawDocumentation)
Deprecated.Set the full unprocessed text of the comment.Tag[]
tags()
Deprecated.Return all tags in this Doc item.Tag[]
tags(String tagname)
Deprecated.Return tags of the specified kind in this Doc item.String
toString()
Deprecated.Returns a string representation of this Doc item.
-
-
-
Field Detail
-
env
protected final DocEnv env
Deprecated.Doc environment
-
treePath
protected com.sun.source.util.TreePath treePath
Deprecated.Back pointer to the tree node for this doc item. May be null if there is no associated tree.
-
documentation
protected String documentation
Deprecated.Raw documentation string.
-
-
Method Detail
-
documentation
protected String documentation()
Deprecated.So subclasses have the option to do lazy initialization of "documentation" string.
-
commentText
public String commentText()
Deprecated.Return the text of the comment for this doc item. TagImpls have been removed.- Specified by:
commentText
in interfaceDoc
- Returns:
- the text of the comment for this doc item.
-
tags
public Tag[] tags()
Deprecated.Return all tags in this Doc item.
-
tags
public Tag[] tags(String tagname)
Deprecated.Return tags of the specified kind in this Doc item.
-
seeTags
public SeeTag[] seeTags()
Deprecated.Return the see also tags in this Doc item.
-
inlineTags
public Tag[] inlineTags()
Deprecated.Description copied from interface:Doc
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 aTag
of kind "Text". Inline tags are represented as aSeeTag
of kind "@see" and name "@link".- Specified by:
inlineTags
in interfaceDoc
- Returns:
- an array of
Tag
s representing the comment
-
firstSentenceTags
public Tag[] firstSentenceTags()
Deprecated.Description copied from interface:Doc
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 aTag
of kind "Text". Inline tags are represented as aSeeTag
of 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)
.- Specified by:
firstSentenceTags
in interfaceDoc
- Returns:
- an array of
Tag
s representing the first sentence of the comment
-
getRawCommentText
public String getRawCommentText()
Deprecated.Return the full unprocessed text of the comment. Tags are included as text. Used mainly for store and retrieve operations like internalization.- Specified by:
getRawCommentText
in interfaceDoc
- Returns:
- the full unprocessed text of the comment.
-
setRawCommentText
public void setRawCommentText(String rawDocumentation)
Deprecated.Set the full unprocessed text of the comment. Tags are included as text. Used mainly for store and retrieve operations like internalization.- Specified by:
setRawCommentText
in interfaceDoc
- Parameters:
rawDocumentation
- A String containing the full unprocessed text of the comment.
-
toString
public String toString()
Deprecated.Returns a string representation of this Doc item.
-
name
public abstract String name()
Deprecated.Returns the name of this Doc item.
-
qualifiedName
public abstract String qualifiedName()
Deprecated.Returns the qualified name of this Doc item.- Returns:
- the name
-
compareTo
public int compareTo(Object obj)
Deprecated.Compares this Object with the specified Object for order. Returns a negative integer, zero, or a positive integer as this Object is less than, equal to, or greater than the given Object.Included so that Doc item are java.lang.Comparable.
- Specified by:
compareTo
in interfaceComparable<Object>
- Specified by:
compareTo
in interfaceDoc
- Parameters:
obj
- theObject
to 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.
-
isField
public boolean isField()
Deprecated.Is this Doc item a field? False until overridden.
-
isEnumConstant
public boolean isEnumConstant()
Deprecated.Is this Doc item an enum constant? False until overridden.- Specified by:
isEnumConstant
in interfaceDoc
- Returns:
- true if it represents an enum constant
-
isConstructor
public boolean isConstructor()
Deprecated.Is this Doc item a constructor? False until overridden.- Specified by:
isConstructor
in interfaceDoc
- Returns:
- true if it represents a constructor
-
isMethod
public boolean isMethod()
Deprecated.Is this Doc item a method (but not a constructor or annotation type element)? False until overridden.
-
isAnnotationTypeElement
public boolean isAnnotationTypeElement()
Deprecated.Is this Doc item an annotation type element? False until overridden.- Specified by:
isAnnotationTypeElement
in interfaceDoc
- Returns:
- true if it represents an annotation type element
-
isInterface
public boolean isInterface()
Deprecated.Is this Doc item a interface (but not an annotation type)? False until overridden.- Specified by:
isInterface
in interfaceDoc
- Returns:
- true if it represents a interface
-
isException
public boolean isException()
Deprecated.Is this Doc item a exception class? False until overridden.- Specified by:
isException
in interfaceDoc
- Returns:
- true if it represents a exception
-
isError
public boolean isError()
Deprecated.Is this Doc item a error class? False until overridden.
-
isEnum
public boolean isEnum()
Deprecated.Is this Doc item an enum type? False until overridden.
-
isAnnotationType
public boolean isAnnotationType()
Deprecated.Is this Doc item an annotation type? False until overridden.- Specified by:
isAnnotationType
in interfaceDoc
- Returns:
- true if it represents an annotation type
-
isOrdinaryClass
public boolean isOrdinaryClass()
Deprecated.Is this Doc item an ordinary class (i.e. not an interface, annotation type, enumeration, exception, or error)? False until overridden.- Specified by:
isOrdinaryClass
in interfaceDoc
- Returns:
- true if it represents an ordinary class
-
isClass
public boolean isClass()
Deprecated.Is this Doc item a class (and not an interface or annotation type)? This includes ordinary classes, enums, errors and exceptions. False until overridden.
-
isIncluded
public abstract boolean isIncluded()
Deprecated.return true if this Doc is include in the active set.- Specified by:
isIncluded
in interfaceDoc
- Returns:
- true if this Doc item is included in the result set.
-
position
public SourcePosition position()
Deprecated.Return the source position of the entity, or null if no position is available.
-
-