01: /*
02: * Copyright 2003-2005 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * 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: */
25:
26: package com.sun.tools.javadoc;
27:
28: import com.sun.javadoc.*;
29:
30: import static com.sun.javadoc.LanguageVersion.*;
31:
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;
37:
38: /**
39: * Represents an element of an annotation type.
40: *
41: * @author Scott Seligman
42: * @version 1.15 07/05/05
43: * @since 1.5
44: */
45:
46: public class AnnotationTypeElementDocImpl extends MethodDocImpl
47: implements AnnotationTypeElementDoc {
48:
49: AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym) {
50: super (env, sym);
51: }
52:
53: AnnotationTypeElementDocImpl(DocEnv env, MethodSymbol sym,
54: String doc, JCMethodDecl tree, Position.LineMap lineMap) {
55: super (env, sym, doc, tree, lineMap);
56: }
57:
58: /**
59: * Returns true, as this is an annotation type element.
60: * (For legacy doclets, return false.)
61: */
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: */
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: */
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: */
87: public AnnotationValue defaultValue() {
88: return (sym.defaultValue == null) ? null
89: : new AnnotationValueImpl(env, sym.defaultValue);
90: }
91: }
|