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