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

Tue, 24 Dec 2013 09:17:37 -0800

author
ksrini
date
Tue, 24 Dec 2013 09:17:37 -0800
changeset 2227
998b10c43157
parent 1755
ddb4a2bfcd82
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com

     1 /*
     2  * Copyright (c) 2003, 2013, 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.source.util.TreePath;
    31 import com.sun.tools.javac.code.Kinds;
    32 import com.sun.tools.javac.code.Scope;
    33 import com.sun.tools.javac.code.Symbol.*;
    34 import com.sun.tools.javac.util.List;
    36 /**
    37  * Represents an annotation type.
    38  *
    39  *  <p><b>This is NOT part of any supported API.
    40  *  If you write code that depends on this, you do so at your own risk.
    41  *  This code and its internal interfaces are subject to change or
    42  *  deletion without notice.</b>
    43  *
    44  * @author Scott Seligman
    45  * @since 1.5
    46  */
    48 public class AnnotationTypeDocImpl
    49         extends ClassDocImpl implements AnnotationTypeDoc {
    51     public AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym) {
    52         this(env, sym, null);
    53     }
    55     public AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym, TreePath treePath) {
    56         super(env, sym, treePath);
    57     }
    59     /**
    60      * Returns true, as this is an annotation type.
    61      * (For legacy doclets, return false.)
    62      */
    63     public boolean isAnnotationType() {
    64         return !isInterface();
    65     }
    67     /**
    68      * Returns false.  Though technically an interface, an annotation
    69      * type is not considered an interface for this purpose.
    70      * (For legacy doclets, returns true.)
    71      */
    72     public boolean isInterface() {
    73         return env.legacyDoclet;
    74     }
    76     /**
    77      * Returns an empty array, as all methods are annotation type elements.
    78      * (For legacy doclets, returns the elements.)
    79      * @see #elements()
    80      */
    81     public MethodDoc[] methods(boolean filter) {
    82         return env.legacyDoclet
    83                 ? (MethodDoc[])elements()
    84                 : new MethodDoc[0];
    85     }
    87     /**
    88      * Returns the elements of this annotation type.
    89      * Returns an empty array if there are none.
    90      * Elements are always public, so no need to filter them.
    91      */
    92     public AnnotationTypeElementDoc[] elements() {
    93         List<AnnotationTypeElementDoc> elements = List.nil();
    94         for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) {
    95             if (e.sym != null && e.sym.kind == Kinds.MTH) {
    96                 MethodSymbol s = (MethodSymbol)e.sym;
    97                 elements = elements.prepend(env.getAnnotationTypeElementDoc(s));
    98             }
    99         }
   100         return
   101             elements.toArray(new AnnotationTypeElementDoc[elements.length()]);
   102     }
   103 }

mercurial