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 */
25
26package com.sun.tools.javadoc.main;
27
28import com.sun.javadoc.*;
29
30import com.sun.source.util.TreePath;
31import 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
46public class AnnotationTypeElementDocImpl
47        extends MethodDocImpl implements AnnotationTypeElementDoc {
48
49    public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym) {
50        super(env, sym);
51    }
52
53    public AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) {
54        super(env, sym, treePath);
55    }
56
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    }
64
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    }
73
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    }
81
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}
92