Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/AnnotationTypeDocImpl.java@24a47c3062fe (annotated)
src/share/classes/com/sun/tools/javadoc/AnnotationTypeDocImpl.java
Thu, 02 Oct 2008 19:58:40 -0700
- author
- xdono
- date
- Thu, 02 Oct 2008 19:58:40 -0700
- changeset 117
- 24a47c3062fe
- parent 113
- eff38cc97183
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell
| duke@1 | 1 | /* |
| xdono@117 | 2 | * Copyright 2003-2008 Sun Microsystems, Inc. All Rights Reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.javadoc.*; |
| duke@1 | 29 | |
| duke@1 | 30 | |
| duke@1 | 31 | import com.sun.tools.javac.code.Kinds; |
| duke@1 | 32 | import com.sun.tools.javac.code.Scope; |
| duke@1 | 33 | import com.sun.tools.javac.code.Symbol.*; |
| duke@1 | 34 | import com.sun.tools.javac.tree.JCTree.*; |
| duke@1 | 35 | import com.sun.tools.javac.util.List; |
| jjg@113 | 36 | import com.sun.tools.javac.util.Names; |
| duke@1 | 37 | import com.sun.tools.javac.util.Position; |
| duke@1 | 38 | |
| duke@1 | 39 | /** |
| duke@1 | 40 | * Represents an annotation type. |
| duke@1 | 41 | * |
| duke@1 | 42 | * @author Scott Seligman |
| duke@1 | 43 | * @since 1.5 |
| duke@1 | 44 | */ |
| duke@1 | 45 | |
| duke@1 | 46 | public class AnnotationTypeDocImpl |
| duke@1 | 47 | extends ClassDocImpl implements AnnotationTypeDoc { |
| duke@1 | 48 | |
| duke@1 | 49 | AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym) { |
| duke@1 | 50 | this(env, sym, null, null, null); |
| duke@1 | 51 | } |
| duke@1 | 52 | |
| duke@1 | 53 | AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym, |
| duke@1 | 54 | String doc, JCClassDecl tree, Position.LineMap lineMap) { |
| duke@1 | 55 | super(env, sym, doc, tree, lineMap); |
| duke@1 | 56 | } |
| duke@1 | 57 | |
| duke@1 | 58 | /** |
| duke@1 | 59 | * Returns true, as this is an annotation type. |
| duke@1 | 60 | * (For legacy doclets, return false.) |
| duke@1 | 61 | */ |
| duke@1 | 62 | public boolean isAnnotationType() { |
| duke@1 | 63 | return !isInterface(); |
| duke@1 | 64 | } |
| duke@1 | 65 | |
| duke@1 | 66 | /** |
| duke@1 | 67 | * Returns false. Though technically an interface, an annotation |
| duke@1 | 68 | * type is not considered an interface for this purpose. |
| duke@1 | 69 | * (For legacy doclets, returns true.) |
| duke@1 | 70 | */ |
| duke@1 | 71 | public boolean isInterface() { |
| duke@1 | 72 | return env.legacyDoclet; |
| duke@1 | 73 | } |
| duke@1 | 74 | |
| duke@1 | 75 | /** |
| duke@1 | 76 | * Returns an empty array, as all methods are annotation type elements. |
| duke@1 | 77 | * (For legacy doclets, returns the elements.) |
| duke@1 | 78 | * @see #elements() |
| duke@1 | 79 | */ |
| duke@1 | 80 | public MethodDoc[] methods(boolean filter) { |
| duke@1 | 81 | return env.legacyDoclet |
| duke@1 | 82 | ? (MethodDoc[])elements() |
| duke@1 | 83 | : new MethodDoc[0]; |
| duke@1 | 84 | } |
| duke@1 | 85 | |
| duke@1 | 86 | /** |
| duke@1 | 87 | * Returns the elements of this annotation type. |
| duke@1 | 88 | * Returns an empty array if there are none. |
| duke@1 | 89 | * Elements are always public, so no need to filter them. |
| duke@1 | 90 | */ |
| duke@1 | 91 | public AnnotationTypeElementDoc[] elements() { |
| jjg@113 | 92 | Names names = tsym.name.table.names; |
| duke@1 | 93 | List<AnnotationTypeElementDoc> elements = List.nil(); |
| duke@1 | 94 | for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) { |
| duke@1 | 95 | if (e.sym != null && e.sym.kind == Kinds.MTH) { |
| duke@1 | 96 | MethodSymbol s = (MethodSymbol)e.sym; |
| duke@1 | 97 | elements = elements.prepend(env.getAnnotationTypeElementDoc(s)); |
| duke@1 | 98 | } |
| duke@1 | 99 | } |
| duke@1 | 100 | return |
| duke@1 | 101 | elements.toArray(new AnnotationTypeElementDoc[elements.length()]); |
| duke@1 | 102 | } |
| duke@1 | 103 | } |
