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

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

Initial load

     1 /*
     2  * Copyright 2003-2005 Sun Microsystems, Inc.  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.  Sun designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    22  * CA 95054 USA or visit www.sun.com if you need additional information or
    23  * have any questions.
    24  */
    26 package com.sun.tools.javadoc;
    28 import com.sun.javadoc.*;
    30 import static com.sun.javadoc.LanguageVersion.*;
    32 import com.sun.tools.javac.code.Symbol.*;
    33 import com.sun.tools.javac.tree.JCTree.*;
    34 import com.sun.tools.javac.util.List;
    35 import com.sun.tools.javac.util.Name;
    36 import com.sun.tools.javac.util.Position;
    38 /**
    39  * Represents an element of an annotation type.
    40  *
    41  * @author Scott Seligman
    42  * @since 1.5
    43  */
    45 public class AnnotationTypeElementDocImpl
    46         extends MethodDocImpl implements AnnotationTypeElementDoc {
    48     AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym) {
    49         super(env, sym);
    50     }
    52     AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym,
    53                                  String doc, JCMethodDecl tree, Position.LineMap lineMap) {
    54         super(env, sym, doc, tree, lineMap);
    55     }
    57     /**
    58      * Returns true, as this is an annotation type element.
    59      * (For legacy doclets, return false.)
    60      */
    61     public boolean isAnnotationTypeElement() {
    62         return !isMethod();
    63     }
    65     /**
    66      * Returns false.  Although this is technically a method, we don't
    67      * consider it one for this purpose.
    68      * (For legacy doclets, return true.)
    69      */
    70     public boolean isMethod() {
    71         return env.legacyDoclet;
    72     }
    74     /**
    75      * Returns false, even though this is indeed abstract.  See
    76      * MethodDocImpl.isAbstract() for the (il)logic behind this.
    77      */
    78     public boolean isAbstract() {
    79         return false;
    80     }
    82     /**
    83      * Returns the default value of this element.
    84      * Returns null if this element has no default.
    85      */
    86     public AnnotationValue defaultValue() {
    87         return (sym.defaultValue == null)
    88                ? null
    89                : new AnnotationValueImpl(env, sym.defaultValue);
    90     }
    91 }

mercurial