Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/AnnotationTypeDocImpl.java@8abc56be3131 (annotated)
src/share/classes/com/sun/tools/javadoc/AnnotationTypeDocImpl.java
Tue, 06 Nov 2012 14:32:49 -0800
- author
- jjg
- date
- Tue, 06 Nov 2012 14:32:49 -0800
- changeset 1397
- 8abc56be3131
- parent 1359
- 25e14ad23cef
- child 1443
- cfde9737131e
- permissions
- -rw-r--r--
8000612: Discrepancy between resources provided in javadoc resource files and resources required by code
Reviewed-by: bpatel
| duke@1 | 1 | /* |
| jjg@1357 | 2 | * Copyright (c) 2003, 2012, Oracle and/or its affiliates. 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 |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle 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 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * 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 | import com.sun.tools.javac.code.Kinds; |
| duke@1 | 31 | import com.sun.tools.javac.code.Scope; |
| duke@1 | 32 | import com.sun.tools.javac.code.Symbol.*; |
| duke@1 | 33 | import com.sun.tools.javac.tree.JCTree.*; |
| duke@1 | 34 | import com.sun.tools.javac.util.List; |
| jjg@113 | 35 | import com.sun.tools.javac.util.Names; |
| duke@1 | 36 | import com.sun.tools.javac.util.Position; |
| duke@1 | 37 | |
| duke@1 | 38 | /** |
| duke@1 | 39 | * Represents an annotation type. |
| duke@1 | 40 | * |
| jjg@1359 | 41 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 42 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 43 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 44 | * deletion without notice.</b> |
| jjg@1359 | 45 | * |
| duke@1 | 46 | * @author Scott Seligman |
| duke@1 | 47 | * @since 1.5 |
| duke@1 | 48 | */ |
| duke@1 | 49 | |
| duke@1 | 50 | public class AnnotationTypeDocImpl |
| duke@1 | 51 | extends ClassDocImpl implements AnnotationTypeDoc { |
| duke@1 | 52 | |
| ksrini@1051 | 53 | public AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym) { |
| duke@1 | 54 | this(env, sym, null, null, null); |
| duke@1 | 55 | } |
| duke@1 | 56 | |
| ksrini@1051 | 57 | public AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym, |
| duke@1 | 58 | String doc, JCClassDecl tree, Position.LineMap lineMap) { |
| duke@1 | 59 | super(env, sym, doc, tree, lineMap); |
| duke@1 | 60 | } |
| duke@1 | 61 | |
| duke@1 | 62 | /** |
| duke@1 | 63 | * Returns true, as this is an annotation type. |
| duke@1 | 64 | * (For legacy doclets, return false.) |
| duke@1 | 65 | */ |
| duke@1 | 66 | public boolean isAnnotationType() { |
| duke@1 | 67 | return !isInterface(); |
| duke@1 | 68 | } |
| duke@1 | 69 | |
| duke@1 | 70 | /** |
| duke@1 | 71 | * Returns false. Though technically an interface, an annotation |
| duke@1 | 72 | * type is not considered an interface for this purpose. |
| duke@1 | 73 | * (For legacy doclets, returns true.) |
| duke@1 | 74 | */ |
| duke@1 | 75 | public boolean isInterface() { |
| duke@1 | 76 | return env.legacyDoclet; |
| duke@1 | 77 | } |
| duke@1 | 78 | |
| duke@1 | 79 | /** |
| duke@1 | 80 | * Returns an empty array, as all methods are annotation type elements. |
| duke@1 | 81 | * (For legacy doclets, returns the elements.) |
| duke@1 | 82 | * @see #elements() |
| duke@1 | 83 | */ |
| duke@1 | 84 | public MethodDoc[] methods(boolean filter) { |
| duke@1 | 85 | return env.legacyDoclet |
| duke@1 | 86 | ? (MethodDoc[])elements() |
| duke@1 | 87 | : new MethodDoc[0]; |
| duke@1 | 88 | } |
| duke@1 | 89 | |
| duke@1 | 90 | /** |
| duke@1 | 91 | * Returns the elements of this annotation type. |
| duke@1 | 92 | * Returns an empty array if there are none. |
| duke@1 | 93 | * Elements are always public, so no need to filter them. |
| duke@1 | 94 | */ |
| duke@1 | 95 | public AnnotationTypeElementDoc[] elements() { |
| jjg@113 | 96 | Names names = tsym.name.table.names; |
| duke@1 | 97 | List<AnnotationTypeElementDoc> elements = List.nil(); |
| duke@1 | 98 | for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) { |
| duke@1 | 99 | if (e.sym != null && e.sym.kind == Kinds.MTH) { |
| duke@1 | 100 | MethodSymbol s = (MethodSymbol)e.sym; |
| duke@1 | 101 | elements = elements.prepend(env.getAnnotationTypeElementDoc(s)); |
| duke@1 | 102 | } |
| duke@1 | 103 | } |
| duke@1 | 104 | return |
| duke@1 | 105 | elements.toArray(new AnnotationTypeElementDoc[elements.length()]); |
| duke@1 | 106 | } |
| duke@1 | 107 | } |
