FileDocCategorySizeDatePackage
ProgramElementDoc.javaAPI DocJava SE 5 API2666Fri Aug 26 14:54:54 BST 2005com.sun.javadoc

ProgramElementDoc

public interface ProgramElementDoc implements 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
MemberDoc
see
ClassDoc
author
Robert Field

Fields Summary
Constructors Summary
Methods Summary
public com.sun.javadoc.AnnotationDesc[]annotations()
Get the annotations of this program element. Return an empty array if there are none.

return
the annotations of this program element.
since
1.5

public com.sun.javadoc.ClassDoccontainingClass()
Get the containing class or interface of this program element.

return
a ClassDoc for this element's containing class or interface. If this is a top-level class or interface, return null.

public com.sun.javadoc.PackageDoccontainingPackage()
Get the package that this program element is contained in.

return
a PackageDoc for this element containing package. If in the unnamed package, this PackageDoc will have the name "".

public booleanisFinal()
Return true if this program element is final.

public booleanisPackagePrivate()
Return true if this program element is package private.

public booleanisPrivate()
Return true if this program element is private.

public booleanisProtected()
Return true if this program element is protected.

public booleanisPublic()
Return true if this program element is public.

public booleanisStatic()
Return true if this program element is static.

public intmodifierSpecifier()
Get the modifier specifier integer.

see
java.lang.reflect.Modifier

public java.lang.Stringmodifiers()
Get modifiers string. For example, for:
public abstract int foo() { ... }
return "public abstract". Annotations are not included.

public java.lang.StringqualifiedName()
Get the fully qualified name of this program element. For example, for the class java.util.Hashtable, return "java.util.Hashtable".

For the method bar() in class Foo in the unnamed package, return "Foo.bar".

return
the qualified name of the program element as a String.