1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/javadoc/AnnotationTypeDocImpl.java Sat Dec 01 00:00:00 2007 +0000
1.3 @@ -0,0 +1,107 @@
1.4 +/*
1.5 + * Copyright 2003-2005 Sun Microsystems, Inc. All Rights Reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Sun designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Sun in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
1.26 + * have any questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.javadoc;
1.30 +
1.31 +import com.sun.javadoc.*;
1.32 +
1.33 +import static com.sun.javadoc.LanguageVersion.*;
1.34 +
1.35 +import com.sun.tools.javac.code.Flags;
1.36 +import com.sun.tools.javac.code.Kinds;
1.37 +import com.sun.tools.javac.code.Scope;
1.38 +import com.sun.tools.javac.code.Symbol;
1.39 +import com.sun.tools.javac.code.Symbol.*;
1.40 +import com.sun.tools.javac.tree.JCTree.*;
1.41 +import com.sun.tools.javac.util.List;
1.42 +import com.sun.tools.javac.util.ListBuffer;
1.43 +import com.sun.tools.javac.util.Name;
1.44 +import com.sun.tools.javac.util.Position;
1.45 +
1.46 +/**
1.47 + * Represents an annotation type.
1.48 + *
1.49 + * @author Scott Seligman
1.50 + * @since 1.5
1.51 + */
1.52 +
1.53 +public class AnnotationTypeDocImpl
1.54 + extends ClassDocImpl implements AnnotationTypeDoc {
1.55 +
1.56 + AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym) {
1.57 + this(env, sym, null, null, null);
1.58 + }
1.59 +
1.60 + AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym,
1.61 + String doc, JCClassDecl tree, Position.LineMap lineMap) {
1.62 + super(env, sym, doc, tree, lineMap);
1.63 + }
1.64 +
1.65 + /**
1.66 + * Returns true, as this is an annotation type.
1.67 + * (For legacy doclets, return false.)
1.68 + */
1.69 + public boolean isAnnotationType() {
1.70 + return !isInterface();
1.71 + }
1.72 +
1.73 + /**
1.74 + * Returns false. Though technically an interface, an annotation
1.75 + * type is not considered an interface for this purpose.
1.76 + * (For legacy doclets, returns true.)
1.77 + */
1.78 + public boolean isInterface() {
1.79 + return env.legacyDoclet;
1.80 + }
1.81 +
1.82 + /**
1.83 + * Returns an empty array, as all methods are annotation type elements.
1.84 + * (For legacy doclets, returns the elements.)
1.85 + * @see #elements()
1.86 + */
1.87 + public MethodDoc[] methods(boolean filter) {
1.88 + return env.legacyDoclet
1.89 + ? (MethodDoc[])elements()
1.90 + : new MethodDoc[0];
1.91 + }
1.92 +
1.93 + /**
1.94 + * Returns the elements of this annotation type.
1.95 + * Returns an empty array if there are none.
1.96 + * Elements are always public, so no need to filter them.
1.97 + */
1.98 + public AnnotationTypeElementDoc[] elements() {
1.99 + Name.Table names = tsym.name.table;
1.100 + List<AnnotationTypeElementDoc> elements = List.nil();
1.101 + for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) {
1.102 + if (e.sym != null && e.sym.kind == Kinds.MTH) {
1.103 + MethodSymbol s = (MethodSymbol)e.sym;
1.104 + elements = elements.prepend(env.getAnnotationTypeElementDoc(s));
1.105 + }
1.106 + }
1.107 + return
1.108 + elements.toArray(new AnnotationTypeElementDoc[elements.length()]);
1.109 + }
1.110 +}
