src/share/classes/com/sun/tools/javadoc/AnnotationTypeElementDocImpl.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

     1 /*
     2  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Oracle in the LICENSE file that accompanied this code.
    10  *
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    14  * version 2 for more details (a copy is included in the LICENSE file that
    15  * accompanied this code).
    16  *
    17  * You should have received a copy of the GNU General Public License version
    18  * 2 along with this work; if not, write to the Free Software Foundation,
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    20  *
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  * or visit www.oracle.com if you need additional information or have any
    23  * questions.
    24  */
    26 package com.sun.tools.javadoc;
    28 import com.sun.javadoc.*;
    30 import com.sun.tools.javac.code.Symbol.*;
    31 import com.sun.tools.javac.tree.JCTree.*;
    32 import com.sun.tools.javac.util.Position;
    34 /**
    35  * Represents an element of an annotation type.
    36  *
    37  *  <p><b>This is NOT part of any supported API.
    38  *  If you write code that depends on this, you do so at your own risk.
    39  *  This code and its internal interfaces are subject to change or
    40  *  deletion without notice.</b>
    41  *
    42  * @author Scott Seligman
    43  * @since 1.5
    44  */
    46 public class AnnotationTypeElementDocImpl
    47         extends MethodDocImpl implements AnnotationTypeElementDoc {
    49     public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym) {
    50         super(env, sym);
    51     }
    53     public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym,
    54                                  String doc, JCMethodDecl tree, Position.LineMap lineMap) {
    55         super(env, sym, doc, tree, lineMap);
    56     }
    58     /**
    59      * Returns true, as this is an annotation type element.
    60      * (For legacy doclets, return false.)
    61      */
    62     public boolean isAnnotationTypeElement() {
    63         return !isMethod();
    64     }
    66     /**
    67      * Returns false.  Although this is technically a method, we don't
    68      * consider it one for this purpose.
    69      * (For legacy doclets, return true.)
    70      */
    71     public boolean isMethod() {
    72         return env.legacyDoclet;
    73     }
    75     /**
    76      * Returns false, even though this is indeed abstract.  See
    77      * MethodDocImpl.isAbstract() for the (il)logic behind this.
    78      */
    79     public boolean isAbstract() {
    80         return false;
    81     }
    83     /**
    84      * Returns the default value of this element.
    85      * Returns null if this element has no default.
    86      */
    87     public AnnotationValue defaultValue() {
    88         return (sym.defaultValue == null)
    89                ? null
    90                : new AnnotationValueImpl(env, sym.defaultValue);
    91     }
    92 }

mercurial