This is NOT part of any supported API. aoqi@0: * If you write code that depends on this, you do so at your own risk. aoqi@0: * This code and its internal interfaces are subject to change or aoqi@0: * deletion without notice. aoqi@0: * aoqi@0: * @see MemberDocImpl aoqi@0: * @see ClassDocImpl aoqi@0: * aoqi@0: * @author Robert Field aoqi@0: * @author Neal Gafter (rewrite) aoqi@0: * @author Scott Seligman (generics, enums, annotations) aoqi@0: */ aoqi@0: public abstract class ProgramElementDocImpl aoqi@0: extends DocImpl implements ProgramElementDoc { aoqi@0: aoqi@0: private final Symbol sym; aoqi@0: aoqi@0: // For source position information. aoqi@0: JCTree tree = null; aoqi@0: Position.LineMap lineMap = null; aoqi@0: aoqi@0: aoqi@0: // Cache for getModifiers(). aoqi@0: private int modifiers = -1; aoqi@0: aoqi@0: protected ProgramElementDocImpl(DocEnv env, Symbol sym, TreePath treePath) { aoqi@0: super(env, treePath); aoqi@0: this.sym = sym; aoqi@0: if (treePath != null) { aoqi@0: tree = (JCTree) treePath.getLeaf(); aoqi@0: lineMap = ((JCCompilationUnit) treePath.getCompilationUnit()).lineMap; aoqi@0: } aoqi@0: } aoqi@0: aoqi@0: @Override aoqi@0: void setTreePath(TreePath treePath) { aoqi@0: super.setTreePath(treePath); aoqi@0: this.tree = (JCTree) treePath.getLeaf(); aoqi@0: this.lineMap = ((JCCompilationUnit) treePath.getCompilationUnit()).lineMap; aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Subclasses override to identify the containing class aoqi@0: */ aoqi@0: protected abstract ClassSymbol getContainingClass(); aoqi@0: aoqi@0: /** aoqi@0: * Returns the flags in terms of javac's flags aoqi@0: */ aoqi@0: abstract protected long getFlags(); aoqi@0: aoqi@0: /** aoqi@0: * Returns the modifier flags in terms of java.lang.reflect.Modifier. aoqi@0: */ aoqi@0: protected int getModifiers() { aoqi@0: if (modifiers == -1) { aoqi@0: modifiers = DocEnv.translateModifiers(getFlags()); aoqi@0: } aoqi@0: return modifiers; aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Get the containing class of this program element. aoqi@0: * aoqi@0: * @return a ClassDocImpl for this element's containing class. aoqi@0: * If this is a class with no outer class, return null. aoqi@0: */ aoqi@0: public ClassDoc containingClass() { aoqi@0: if (getContainingClass() == null) { aoqi@0: return null; aoqi@0: } aoqi@0: return env.getClassDoc(getContainingClass()); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Return the package that this member is contained in. aoqi@0: * Return "" if in unnamed package. aoqi@0: */ aoqi@0: public PackageDoc containingPackage() { aoqi@0: return env.getPackageDoc(getContainingClass().packge()); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Get the modifier specifier integer. aoqi@0: * aoqi@0: * @see java.lang.reflect.Modifier aoqi@0: */ aoqi@0: public int modifierSpecifier() { aoqi@0: int modifiers = getModifiers(); aoqi@0: if (isMethod() && containingClass().isInterface()) aoqi@0: // Remove the implicit abstract modifier. aoqi@0: return modifiers & ~Modifier.ABSTRACT; aoqi@0: return modifiers; aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Get modifiers string. aoqi@0: *
aoqi@0: * Example, for:
aoqi@0: * public abstract int foo() { ... }
aoqi@0: * modifiers() would return:
aoqi@0: * 'public abstract'
aoqi@0: *
aoqi@0: * Annotations are not included.
aoqi@0: */
aoqi@0: public String modifiers() {
aoqi@0: int modifiers = getModifiers();
aoqi@0: if (isAnnotationTypeElement() ||
aoqi@0: (isMethod() && containingClass().isInterface())) {
aoqi@0: // Remove the implicit abstract modifier.
aoqi@0: return Modifier.toString(modifiers & ~Modifier.ABSTRACT);
aoqi@0: } else {
aoqi@0: return Modifier.toString(modifiers);
aoqi@0: }
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Get the annotations of this program element.
aoqi@0: * Return an empty array if there are none.
aoqi@0: */
aoqi@0: public AnnotationDesc[] annotations() {
aoqi@0: AnnotationDesc res[] = new AnnotationDesc[sym.getRawAttributes().length()];
aoqi@0: int i = 0;
aoqi@0: for (Attribute.Compound a : sym.getRawAttributes()) {
aoqi@0: res[i++] = new AnnotationDescImpl(env, a);
aoqi@0: }
aoqi@0: return res;
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Return true if this program element is public
aoqi@0: */
aoqi@0: public boolean isPublic() {
aoqi@0: int modifiers = getModifiers();
aoqi@0: return Modifier.isPublic(modifiers);
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Return true if this program element is protected
aoqi@0: */
aoqi@0: public boolean isProtected() {
aoqi@0: int modifiers = getModifiers();
aoqi@0: return Modifier.isProtected(modifiers);
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Return true if this program element is private
aoqi@0: */
aoqi@0: public boolean isPrivate() {
aoqi@0: int modifiers = getModifiers();
aoqi@0: return Modifier.isPrivate(modifiers);
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Return true if this program element is package private
aoqi@0: */
aoqi@0: public boolean isPackagePrivate() {
aoqi@0: return !(isPublic() || isPrivate() || isProtected());
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Return true if this program element is static
aoqi@0: */
aoqi@0: public boolean isStatic() {
aoqi@0: int modifiers = getModifiers();
aoqi@0: return Modifier.isStatic(modifiers);
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Return true if this program element is final
aoqi@0: */
aoqi@0: public boolean isFinal() {
aoqi@0: int modifiers = getModifiers();
aoqi@0: return Modifier.isFinal(modifiers);
aoqi@0: }
aoqi@0:
aoqi@0: /**
aoqi@0: * Generate a key for sorting.
aoqi@0: */
aoqi@0: CollationKey generateKey() {
aoqi@0: String k = name();
aoqi@0: // System.out.println("COLLATION KEY FOR " + this + " is \"" + k + "\"");
aoqi@0: return env.doclocale.collator.getCollationKey(k);
aoqi@0: }
aoqi@0:
aoqi@0: }