1 /*
2 * Copyright (c) 2005, 2024, 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 javax.lang.model.element;
27
28
29 /**
30 * Represents a modifier on a program element such
31 * as a class, method, or field.
32 *
33 * <p>Not all modifiers are applicable to all kinds of elements.
34 * When two or more modifiers appear in the source code of an element
35 * then it is customary, though not required, that they appear in the same
36 * order as the constants listed in the detail section below.
37 *
38 * <p>Note that it is possible additional modifiers will be added in
39 * future versions of the platform.
40 *
41 * @jls 8.1.1 Class Modifiers
42 * @jls 8.3.1 Field Modifiers
43 * @jls 8.4.3 Method Modifiers
44 * @jls 8.8.3 Constructor Modifiers
45 * @jls 9.1.1 Interface Modifiers
46 *
47 * @since 1.6
48 */
49
50 public enum Modifier {
51
52 // Note java.lang.reflect.Modifier includes INTERFACE, but that's a VMism.
53
54 /**
55 * The modifier {@code public}
56 *
57 * @jls 6.6 Access Control
58 */
59 PUBLIC,
60
61 /**
62 * The modifier {@code protected}
63 *
64 * @jls 6.6 Access Control
65 */
66 PROTECTED,
67
68 /**
69 * The modifier {@code private}
70 *
71 * @jls 6.6 Access Control
72 */
73 PRIVATE,
74
75 /**
76 * The modifier {@code abstract}
77 *
78 * @jls 8.1.1.1 {@code abstract} Classes
79 * @jls 8.4.3.1 {@code abstract} Methods
80 * @jls 9.1.1.1 {@code abstract} Interfaces
81 */
82 ABSTRACT,
83
84 /**
85 * The modifier {@code default}
86 *
87 * @jls 9.4 Method Declarations
88 * @since 1.8
89 */
90 DEFAULT,
91
92 /**
93 * The modifier {@code static}
94 *
95 * @jls 8.1.1.4 {@code static} Classes
96 * @jls 8.3.1.1 {@code static} Fields
97 * @jls 8.4.3.2 {@code static} Methods
98 * @jls 9.1.1.3 {@code static} Interfaces
99 */
100 STATIC,
101
102 /**
103 * The modifier {@code sealed}
104 *
105 * @jls 8.1.1.2 {@code sealed}, {@code non-sealed}, and {@code final} Classes
106 * @jls 9.1.1.4 {@code sealed} and {@code non-sealed} Interfaces
107 * @since 17
108 */
109 SEALED,
110
111 /**
112 * The modifier {@code non-sealed}
113 *
114 * @jls 8.1.1.2 {@code sealed}, {@code non-sealed}, and {@code final} Classes
115 * @jls 9.1.1.4 {@code sealed} and {@code non-sealed} Interfaces
116 * @since 17
117 */
118 NON_SEALED {
119 public String toString() {
120 return "non-sealed";
121 }
122 },
123
124 /**
125 * The modifier {@code value}
126 * @since 18
127 */
128 VALUE,
129 /**
130 * The modifier {@code final}
131 *
132 * @jls 8.1.1.2 {@code sealed}, {@code non-sealed}, and {@code final} Classes
133 * @jls 8.3.1.2 {@code final} Fields
134 * @jls 8.4.3.3 {@code final} Methods
135 */
136 FINAL,
137
138 /**
139 * The modifier {@code transient}
140 *
141 * @jls 8.3.1.3 {@code transient} Fields
142 */
143 TRANSIENT,
144
145 /**
146 * The modifier {@code volatile}
147 *
148 * @jls 8.3.1.4 {@code volatile} Fields
149 */
150 VOLATILE,
151
152 /**
153 * The modifier {@code synchronized}
154 *
155 * @jls 8.4.3.6 {@code synchronized} Methods
156 */
157 SYNCHRONIZED,
158
159 /**
160 * The modifier {@code native}
161 *
162 * @jls 8.4.3.4 {@code native} Methods
163 */
164 NATIVE,
165
166 /**
167 * The modifier {@code strictfp}
168 *
169 * @jls 8.1.1.3 {@code strictfp} Classes
170 * @jls 8.4.3.5 {@code strictfp} Methods
171 * @jls 9.1.1.2 {@code strictfp} Interfaces
172 */
173 STRICTFP;
174
175 /**
176 * Returns this modifier's name as defined in <cite>The
177 * Java Language Specification</cite>.
178 * The modifier name is the {@linkplain #name() name of the enum
179 * constant} in lowercase and with any underscores ("{@code _}")
180 * replaced with hyphens ("{@code -}").
181 * @return the modifier's name
182 */
183 @Override
184 public String toString() {
185 return name().toLowerCase(java.util.Locale.US);
186 }
187 }