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