1 /*
2  * Copyright (c) 2003, 2018, 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  */
25 
26 package com.sun.tools.javadoc.main;
27 
28 import com.sun.javadoc.*;
29 
30 import com.sun.source.util.TreePath;
31 import com.sun.tools.javac.code.Symbol.*;
32 
33 /**
34  * Represents an element of an annotation type.
35  *
36  *  <p><b>This is NOT part of any supported API.
37  *  If you write code that depends on this, you do so at your own risk.
38  *  This code and its internal interfaces are subject to change or
39  *  deletion without notice.</b>
40  *
41  * @author Scott Seligman
42  * @since 1.5
43  */
44 
45 @Deprecated(since="9", forRemoval=true)
46 @SuppressWarnings("removal")
47 public class AnnotationTypeElementDocImpl
48         extends MethodDocImpl implements AnnotationTypeElementDoc {
49 
AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym)50     public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym) {
51         super(env, sym);
52     }
53 
AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath)54     public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) {
55         super(env, sym, treePath);
56     }
57 
58     /**
59      * Returns true, as this is an annotation type element.
60      * (For legacy doclets, return false.)
61      */
isAnnotationTypeElement()62     public boolean isAnnotationTypeElement() {
63         return !isMethod();
64     }
65 
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      */
isMethod()71     public boolean isMethod() {
72         return env.legacyDoclet;
73     }
74 
75     /**
76      * Returns false, even though this is indeed abstract.  See
77      * MethodDocImpl.isAbstract() for the (il)logic behind this.
78      */
isAbstract()79     public boolean isAbstract() {
80         return false;
81     }
82 
83     /**
84      * Returns the default value of this element.
85      * Returns null if this element has no default.
86      */
defaultValue()87     public AnnotationValue defaultValue() {
88         return (sym.defaultValue == null)
89                ? null
90                : new AnnotationValueImpl(env, sym.defaultValue);
91     }
92 }
93