Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/javadoc/AnnotationTypeElementDocImpl.java@25e14ad23cef (annotated)
src/share/classes/com/sun/tools/javadoc/AnnotationTypeElementDocImpl.java
Wed, 10 Oct 2012 16:48:21 -0700
- author
- jjg
- date
- Wed, 10 Oct 2012 16:48:21 -0700
- changeset 1359
- 25e14ad23cef
- parent 1357
- c75be5bc5283
- child 1443
- cfde9737131e
- permissions
- -rw-r--r--
8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy
| 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.Symbol.*; |
| duke@1 | 31 | import com.sun.tools.javac.tree.JCTree.*; |
| duke@1 | 32 | import com.sun.tools.javac.util.Position; |
| duke@1 | 33 | |
| duke@1 | 34 | /** |
| duke@1 | 35 | * Represents an element of an annotation type. |
| duke@1 | 36 | * |
| jjg@1359 | 37 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 38 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 39 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 40 | * deletion without notice.</b> |
| jjg@1359 | 41 | * |
| duke@1 | 42 | * @author Scott Seligman |
| duke@1 | 43 | * @since 1.5 |
| duke@1 | 44 | */ |
| duke@1 | 45 | |
| duke@1 | 46 | public class AnnotationTypeElementDocImpl |
| duke@1 | 47 | extends MethodDocImpl implements AnnotationTypeElementDoc { |
| duke@1 | 48 | |
| ksrini@1051 | 49 | public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym) { |
| duke@1 | 50 | super(env, sym); |
| duke@1 | 51 | } |
| duke@1 | 52 | |
| ksrini@1051 | 53 | public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym, |
| duke@1 | 54 | String doc, JCMethodDecl 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 element. |
| duke@1 | 60 | * (For legacy doclets, return false.) |
| duke@1 | 61 | */ |
| duke@1 | 62 | public boolean isAnnotationTypeElement() { |
| duke@1 | 63 | return !isMethod(); |
| duke@1 | 64 | } |
| duke@1 | 65 | |
| duke@1 | 66 | /** |
| duke@1 | 67 | * Returns false. Although this is technically a method, we don't |
| duke@1 | 68 | * consider it one for this purpose. |
| duke@1 | 69 | * (For legacy doclets, return true.) |
| duke@1 | 70 | */ |
| duke@1 | 71 | public boolean isMethod() { |
| duke@1 | 72 | return env.legacyDoclet; |
| duke@1 | 73 | } |
| duke@1 | 74 | |
| duke@1 | 75 | /** |
| duke@1 | 76 | * Returns false, even though this is indeed abstract. See |
| duke@1 | 77 | * MethodDocImpl.isAbstract() for the (il)logic behind this. |
| duke@1 | 78 | */ |
| duke@1 | 79 | public boolean isAbstract() { |
| duke@1 | 80 | return false; |
| duke@1 | 81 | } |
| duke@1 | 82 | |
| duke@1 | 83 | /** |
| duke@1 | 84 | * Returns the default value of this element. |
| duke@1 | 85 | * Returns null if this element has no default. |
| duke@1 | 86 | */ |
| duke@1 | 87 | public AnnotationValue defaultValue() { |
| duke@1 | 88 | return (sym.defaultValue == null) |
| duke@1 | 89 | ? null |
| duke@1 | 90 | : new AnnotationValueImpl(env, sym.defaultValue); |
| duke@1 | 91 | } |
| duke@1 | 92 | } |
