01 /*
02 * Copyright 2005-2006 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 javax.lang.model.element;
27
28 /**
29 * Represents a modifier on a program element such
30 * as a class, method, or field.
31 *
32 * <p>Not all modifiers are applicable to all kinds of elements.
33 * When two or more modifiers appear in the source code of an element
34 * then it is customary, though not required, that they appear in the same
35 * order as the constants listed in the detail section below.
36 *
37 * <p>Note that it is possible additional modifiers will be added in
38 * future versions of the platform.
39 *
40 * @author Joseph D. Darcy
41 * @author Scott Seligman
42 * @author Peter von der Ahé
43 * @version 1.9 07/05/05
44 * @since 1.6
45 */
46
47 public enum Modifier {
48
49 // See JLS2 sections 8.1.1, 8.3.1, 8.4.3, 8.8.3, and 9.1.1.
50 // java.lang.reflect.Modifier includes INTERFACE, but that's a VMism.
51
52 /** The modifier {@code public} */
53 PUBLIC,
54 /** The modifier {@code protected} */
55 PROTECTED,
56 /** The modifier {@code private} */
57 PRIVATE,
58 /** The modifier {@code abstract} */
59 ABSTRACT,
60 /** The modifier {@code static} */
61 STATIC,
62 /** The modifier {@code final} */
63 FINAL,
64 /** The modifier {@code transient} */
65 TRANSIENT,
66 /** The modifier {@code volatile} */
67 VOLATILE,
68 /** The modifier {@code synchronized} */
69 SYNCHRONIZED,
70 /** The modifier {@code native} */
71 NATIVE,
72 /** The modifier {@code strictfp} */
73 STRICTFP;
74
75 private String lowercase = null; // modifier name in lowercase
76
77 /**
78 * Returns this modifier's name in lowercase.
79 */
80 public String toString() {
81 if (lowercase == null) {
82 lowercase = name().toLowerCase(java.util.Locale.US);
83 }
84 return lowercase;
85 }
86 }
|