author | darcy |
Wed, 27 Sep 2017 14:23:41 -0700 | |
changeset 47283 | ce5fd3ba3fea |
parent 47216 | 71c04702a3d5 |
child 55118 | 9ea55cb79d77 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
43567
d0d89c3da7be
8173676: Improvements to javax.annotation.processing and javax.lang.model doc
darcy
parents:
36526
diff
changeset
|
2 |
* Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
26 |
package javax.lang.model.element; |
|
27 |
||
11553
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
28 |
import java.util.List; |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
29 |
|
10 | 30 |
/** |
31 |
* Represents a package program element. Provides access to information |
|
32 |
* about the package and its members. |
|
33 |
* |
|
34 |
* @author Joseph D. Darcy |
|
35 |
* @author Scott Seligman |
|
36 |
* @author Peter von der Ahé |
|
37 |
* @see javax.lang.model.util.Elements#getPackageOf |
|
38 |
* @since 1.6 |
|
39 |
*/ |
|
2088
6e2c8594b2e5
6460529: Provide mixin interfaces for getQualifiedName and getTypeParameters
darcy
parents:
10
diff
changeset
|
40 |
public interface PackageElement extends Element, QualifiedNameable { |
10 | 41 |
|
42 |
/** |
|
43 |
* Returns the fully qualified name of this package. |
|
44 |
* This is also known as the package's <i>canonical</i> name. |
|
43567
d0d89c3da7be
8173676: Improvements to javax.annotation.processing and javax.lang.model doc
darcy
parents:
36526
diff
changeset
|
45 |
* For an {@linkplain #isUnnamed() unnamed package}, an empty name is returned. |
10 | 46 |
* |
45687 | 47 |
* @apiNote The fully qualified name of a named package that is |
48 |
* not a subpackage of a named package is its simple name. The |
|
49 |
* fully qualified name of a named package that is a subpackage of |
|
50 |
* another named package consists of the fully qualified name of |
|
51 |
* the containing package, followed by "{@code .}", followed by the simple |
|
52 |
* (member) name of the subpackage. |
|
53 |
* |
|
10 | 54 |
* @return the fully qualified name of this package, or an |
55 |
* empty name if this is an unnamed package |
|
9303
eae35c201e19
7032975: API files in javax.annotation.processing need to be updated for references to JLS
jjh
parents:
8233
diff
changeset
|
56 |
* @jls 6.7 Fully Qualified Names and Canonical Names |
10 | 57 |
*/ |
58 |
Name getQualifiedName(); |
|
59 |
||
60 |
/** |
|
43567
d0d89c3da7be
8173676: Improvements to javax.annotation.processing and javax.lang.model doc
darcy
parents:
36526
diff
changeset
|
61 |
* Returns the simple name of this package. For an {@linkplain |
d0d89c3da7be
8173676: Improvements to javax.annotation.processing and javax.lang.model doc
darcy
parents:
36526
diff
changeset
|
62 |
* #isUnnamed() unnamed package}, an empty name is returned. |
8233
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
63 |
* |
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
64 |
* @return the simple name of this package or an empty name if |
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
65 |
* this is an unnamed package |
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
66 |
*/ |
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
67 |
@Override |
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
68 |
Name getSimpleName(); |
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
69 |
|
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
70 |
/** |
11553
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
71 |
* Returns the {@linkplain NestingKind#TOP_LEVEL top-level} |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
72 |
* classes and interfaces within this package. Note that |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
73 |
* subpackages are <em>not</em> considered to be enclosed by a |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
74 |
* package. |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
75 |
* |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
76 |
* @return the top-level classes and interfaces within this |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
77 |
* package |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
78 |
*/ |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
79 |
@Override |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
80 |
List<? extends Element> getEnclosedElements(); |
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
81 |
|
4389b722f8dc
7130768: Clarify behavior of Element.getEnclosingElements in subtypes
darcy
parents:
9303
diff
changeset
|
82 |
/** |
36526 | 83 |
* Returns {@code true} if this is an unnamed package and {@code |
10 | 84 |
* false} otherwise. |
85 |
* |
|
36526 | 86 |
* @return {@code true} if this is an unnamed package and {@code |
10 | 87 |
* false} otherwise |
9303
eae35c201e19
7032975: API files in javax.annotation.processing need to be updated for references to JLS
jjh
parents:
8233
diff
changeset
|
88 |
* @jls 7.4.2 Unnamed Packages |
10 | 89 |
*/ |
90 |
boolean isUnnamed(); |
|
8233
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
91 |
|
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
92 |
/** |
43571
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
93 |
* Returns the enclosing module if such a module exists; otherwise |
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
94 |
* returns {@code null}. |
8233
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
95 |
* |
43571
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
96 |
* One situation where a module does not exist for a package is if |
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
97 |
* the environment does not include modules, such as an annotation |
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
98 |
* processing environment configured for a {@linkplain |
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
99 |
* javax.annotation.processing.ProcessingEnvironment#getSourceVersion |
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
100 |
* source version} without modules. |
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
101 |
* |
a153580d1741
8173776: More javax.lang.model improvements to support modules
darcy
parents:
43567
diff
changeset
|
102 |
* @return the enclosing module or {@code null} if no such module exists |
43767
9cff98a149cb
8173393: Module system implementation refresh (2/2017)
alanb
parents:
43571
diff
changeset
|
103 |
* |
9cff98a149cb
8173393: Module system implementation refresh (2/2017)
alanb
parents:
43571
diff
changeset
|
104 |
* @revised 9 |
9cff98a149cb
8173393: Module system implementation refresh (2/2017)
alanb
parents:
43571
diff
changeset
|
105 |
* @spec JPMS |
8233
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
106 |
*/ |
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
107 |
@Override |
fda68eae1504
7015530: Reiterate API specializations in javax.lang.model.elment subinterfaces
darcy
parents:
5520
diff
changeset
|
108 |
Element getEnclosingElement(); |
10 | 109 |
} |