src/share/classes/com/sun/tools/javadoc/AnnotationTypeElementDocImpl.java

Fri, 05 Aug 2011 19:41:05 -0700

author
ksrini
date
Fri, 05 Aug 2011 19:41:05 -0700
changeset 1065
e9f118c2bd3c
parent 1051
b0909f992710
child 1357
c75be5bc5283
permissions
-rw-r--r--

7064544: (javadoc) miscellaneous fixes requested by netbeans
Summary: Contributed by netbeans team, modified to suit by the langtools team.
Reviewed-by: jjg, bpatel

duke@1 1 /*
ksrini@1051 2 * Copyright (c) 2003, 2011, 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 static com.sun.javadoc.LanguageVersion.*;
duke@1 31
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;
duke@1 35 import com.sun.tools.javac.util.Name;
duke@1 36 import com.sun.tools.javac.util.Position;
duke@1 37
duke@1 38 /**
duke@1 39 * Represents an element of an annotation type.
duke@1 40 *
duke@1 41 * @author Scott Seligman
duke@1 42 * @since 1.5
duke@1 43 */
duke@1 44
duke@1 45 public class AnnotationTypeElementDocImpl
duke@1 46 extends MethodDocImpl implements AnnotationTypeElementDoc {
duke@1 47
ksrini@1051 48 public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym) {
duke@1 49 super(env, sym);
duke@1 50 }
duke@1 51
ksrini@1051 52 public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym,
duke@1 53 String doc, JCMethodDecl tree, Position.LineMap lineMap) {
duke@1 54 super(env, sym, doc, tree, lineMap);
duke@1 55 }
duke@1 56
duke@1 57 /**
duke@1 58 * Returns true, as this is an annotation type element.
duke@1 59 * (For legacy doclets, return false.)
duke@1 60 */
duke@1 61 public boolean isAnnotationTypeElement() {
duke@1 62 return !isMethod();
duke@1 63 }
duke@1 64
duke@1 65 /**
duke@1 66 * Returns false. Although this is technically a method, we don't
duke@1 67 * consider it one for this purpose.
duke@1 68 * (For legacy doclets, return true.)
duke@1 69 */
duke@1 70 public boolean isMethod() {
duke@1 71 return env.legacyDoclet;
duke@1 72 }
duke@1 73
duke@1 74 /**
duke@1 75 * Returns false, even though this is indeed abstract. See
duke@1 76 * MethodDocImpl.isAbstract() for the (il)logic behind this.
duke@1 77 */
duke@1 78 public boolean isAbstract() {
duke@1 79 return false;
duke@1 80 }
duke@1 81
duke@1 82 /**
duke@1 83 * Returns the default value of this element.
duke@1 84 * Returns null if this element has no default.
duke@1 85 */
duke@1 86 public AnnotationValue defaultValue() {
duke@1 87 return (sym.defaultValue == null)
duke@1 88 ? null
duke@1 89 : new AnnotationValueImpl(env, sym.defaultValue);
duke@1 90 }
duke@1 91 }

mercurial