Class sun.tools.javadoc.ProgramElementDoc
java.lang.Object
|
+----sun.tools.javadoc.Doc
|
+----sun.tools.javadoc.ProgramElementDoc
- Subclasses:
- ClassDoc, MemberDoc
- public abstract class ProgramElementDoc
- extends Doc
Represents a java program element: class, interface, field,
constructor, or method.
This is an abstract class dealing with information common to
these elements.
- See Also:
- MemberDoc, ClassDoc
Method Summary
|
ClassDoc
|
containingClass()
Get the containing class of this program element.
|
boolean
|
isFinal()
Return true if this program element is final
|
boolean
|
isPackagePrivate()
Return true if this program element is package private
|
boolean
|
isPrivate()
Return true if this program element is private
|
boolean
|
isProtected()
Return true if this program element is protected
|
boolean
|
isPublic()
Return true if this program element is public
|
boolean
|
isStatic()
Return true if this program element is static
|
java.lang.String
|
modifiers()
Get modifiers string.
|
int
|
modifierSpecifier()
Get the modifier specifier integer.
|
Methods inherited from class sun.tools.javadoc.Doc
|
commentText, compareTo, getRawCommentText, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, seeTags, setRawCommentText, tags, tags, toString |
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
containingClass
public ClassDoc containingClass()
- Get the containing class of this program element.
- Returns:
- a ClassDoc for this element's containing class.
If this is a class with no outer class, return null.
modifierSpecifier
public int modifierSpecifier()
- Get the modifier specifier integer.
- See Also:
- java.lang.reflect.Modifier
modifiers
public java.lang.String modifiers()
- Get modifiers string.
Example, for:
public abstract int foo() { ... }
modifiers() would return:
'public abstract'
isPublic
public boolean isPublic()
- Return true if this program element is public
isProtected
public boolean isProtected()
- Return true if this program element is protected
isPrivate
public boolean isPrivate()
- Return true if this program element is private
isPackagePrivate
public boolean isPackagePrivate()
- Return true if this program element is package private
isStatic
public boolean isStatic()
- Return true if this program element is static
isFinal
public boolean isFinal()
- Return true if this program element is final