net.cscott.sinjdoc

Interface ProgramElementDoc

public interface ProgramElementDoc extends Doc

The ProgramElementDoc class represents a java program element: class, interface, field, constructor, or method. This is an abstract class dealing with information common to these elements.

Version: $Id: ProgramElementDoc.java,v 1.6 2003/06/25 01:51:52 cananian Exp $

Author: C. Scott Ananian (cscott@cscott.net)

See Also: com.sun.javadoc.ProgramElementDoc

Method Summary
String	canonicalName() Return the fully-qualified name of this program element.
ClassDoc	containingClass() Return the containing class of this program element.
PackageDoc	containingPackage() Return the package that this program element is contained in.
boolean	isFinal() Return true if this program element is final.
boolean	isPackage() 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.
String	modifiers() Get the modifiers string.
int	modifierSpecifier() Get the modifier specifier integer.

Return the fully-qualified name of this program element. For example, for the class java.util.Hashtable, return "java.util.Hashtable". For the method bar(String str, int i) in the class Foo in the unnamed package, return "Foo.bar(java.lang.String,int)" (where all parameter types are also given their canonical names). See section 6.7 of the JLS for the difference between canonical and fully-qualified names.