1 /* ProgramElementDoc.java -- Common ops for all program elements.
2 Copyright (C) 1999 Free Software Foundation, Inc.
3
4 This file is part of GNU Classpath.
5
6 GNU Classpath is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
9 any later version.
10
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301 USA.
20
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
25
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
37
38
39 package com.sun.javadoc;
40
41 /**
42 * This is the comment super-interface of all items that are "program
43 * elements". This includes classes, interfaces, fields, constructors,
44 * and methods.
45 */
46 public interface ProgramElementDoc extends Doc
47 {
48
49 /**
50 * This method returns the class which contains this element. If this
51 * is a class that is not an inner class, <code>null</code> will be
52 * returned.
53 *
54 * @returned The class element that contains this item, or <code>null</code>
55 * if this item is a class that is not an inner class.
56 */
57 public abstract ClassDoc
containingClass()58 containingClass();
59
60 /*************************************************************************/
61
62 /**
63 * This method returns the package which contains this element. If this
64 * element is in the default generic package, then the name of the
65 * package element returned will be "".
66 *
67 * @return The package element that contains this item.
68 */
69 public abstract PackageDoc
containingPackage()70 containingPackage();
71
72 /*************************************************************************/
73
74 /**
75 * This method returns the fully qualified name of this element.
76 *
77 * @return The fully qualified name of this element.
78 */
79 public abstract String
qualifiedName()80 qualifiedName();
81
82 /*************************************************************************/
83
84 /**
85 * This method returns the modifier specificier number, which is what?
86 *
87 * @return The modifier for this element.
88 */
89 public abstract int
modifierSpecifier()90 modifierSpecifier();
91
92 /*************************************************************************/
93
94 /**
95 * This method returns a string with the element modifiers. For example,
96 * the modifiers of a method declaration might be "protected abstract".
97 *
98 * @return The modifier string.
99 */
100 public abstract String
modifiers()101 modifiers();
102
103 /*************************************************************************/
104
105 /**
106 * This method tests whether or not this element is public.
107 *
108 * @return <code>true</code> if this element is public, <code>false</code>
109 * otherwise.
110 */
111 public abstract boolean
isPublic()112 isPublic();
113
114 /*************************************************************************/
115
116 /**
117 * This method tests whether or not this element is protected.
118 *
119 * @return <code>true</code> if this element is protected, <code>false</code>
120 * otherwise.
121 */
122 public abstract boolean
isProtected()123 isProtected();
124
125 /*************************************************************************/
126
127 /**
128 * This method tests whether or not this element is private.
129 *
130 * @return <code>true</code> if this element is private, <code>false</code>
131 * otherwise.
132 */
133 public abstract boolean
isPrivate()134 isPrivate();
135
136 /*************************************************************************/
137
138 /**
139 * This method tests whether or not this element is package private.
140 *
141 * @return <code>true</code> if this element is package private,
142 * <code>false</code> otherwise.
143 */
144 public abstract boolean
isPackagePrivate()145 isPackagePrivate();
146
147 /*************************************************************************/
148
149 /**
150 * This method tests whether or not this element is static.
151 *
152 * @return <code>true</code> if this element is static, <code>false</code>
153 * otherwise.
154 */
155 public abstract boolean
isStatic()156 isStatic();
157
158 /*************************************************************************/
159
160 /**
161 * This method tests whether or not this element is final.
162 *
163 * @return <code>true</code> if this element is final, <code>false</code>
164 * otherwise.
165 */
166 public abstract boolean
isFinal()167 isFinal();
168
169 } // interface ProgramElementDoc
170