duke@1: /*
jjg@1755:  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javadoc;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: 
jjg@1443: import com.sun.source.util.TreePath;
duke@1: import com.sun.tools.javac.code.Kinds;
duke@1: import com.sun.tools.javac.code.Scope;
duke@1: import com.sun.tools.javac.code.Symbol.*;
duke@1: import com.sun.tools.javac.util.List;
duke@1: 
duke@1: /**
duke@1:  * Represents an annotation type.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
duke@1:  * @author Scott Seligman
duke@1:  * @since 1.5
duke@1:  */
duke@1: 
duke@1: public class AnnotationTypeDocImpl
duke@1:         extends ClassDocImpl implements AnnotationTypeDoc {
duke@1: 
ksrini@1051:     public AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym) {
jjg@1443:         this(env, sym, null);
duke@1:     }
duke@1: 
jjg@1443:     public AnnotationTypeDocImpl(DocEnv env, ClassSymbol sym, TreePath treePath) {
jjg@1443:         super(env, sym, treePath);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns true, as this is an annotation type.
duke@1:      * (For legacy doclets, return false.)
duke@1:      */
duke@1:     public boolean isAnnotationType() {
duke@1:         return !isInterface();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns false.  Though technically an interface, an annotation
duke@1:      * type is not considered an interface for this purpose.
duke@1:      * (For legacy doclets, returns true.)
duke@1:      */
duke@1:     public boolean isInterface() {
duke@1:         return env.legacyDoclet;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns an empty array, as all methods are annotation type elements.
duke@1:      * (For legacy doclets, returns the elements.)
duke@1:      * @see #elements()
duke@1:      */
duke@1:     public MethodDoc[] methods(boolean filter) {
duke@1:         return env.legacyDoclet
duke@1:                 ? (MethodDoc[])elements()
duke@1:                 : new MethodDoc[0];
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns the elements of this annotation type.
duke@1:      * Returns an empty array if there are none.
duke@1:      * Elements are always public, so no need to filter them.
duke@1:      */
duke@1:     public AnnotationTypeElementDoc[] elements() {
duke@1:         List<AnnotationTypeElementDoc> elements = List.nil();
duke@1:         for (Scope.Entry e = tsym.members().elems; e != null; e = e.sibling) {
duke@1:             if (e.sym != null && e.sym.kind == Kinds.MTH) {
duke@1:                 MethodSymbol s = (MethodSymbol)e.sym;
duke@1:                 elements = elements.prepend(env.getAnnotationTypeElementDoc(s));
duke@1:             }
duke@1:         }
duke@1:         return
duke@1:             elements.toArray(new AnnotationTypeElementDoc[elements.length()]);
duke@1:     }
duke@1: }