View Javadoc
1   /*
2    * Copyright (c) 2005, 2013, 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   * @author Joseph D. Darcy
42   * @author Scott Seligman
43   * @author Peter von der Ah&eacute;
44   * @since 1.6
45   */
46  
47  public enum Modifier {
48  
49      // See JLS 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} */          PUBLIC,
53      /** The modifier {@code protected} */       PROTECTED,
54      /** The modifier {@code private} */         PRIVATE,
55      /** The modifier {@code abstract} */        ABSTRACT,
56      /**
57       * The modifier {@code default}
58       * @since 1.8
59       */
60       DEFAULT,
61      /** The modifier {@code static} */          STATIC,
62      /** The modifier {@code final} */           FINAL,
63      /** The modifier {@code transient} */       TRANSIENT,
64      /** The modifier {@code volatile} */        VOLATILE,
65      /** The modifier {@code synchronized} */    SYNCHRONIZED,
66      /** The modifier {@code native} */          NATIVE,
67      /** The modifier {@code strictfp} */        STRICTFP;
68  
69      /**
70       * Returns this modifier's name in lowercase.
71       */
72      public String toString() {
73          return name().toLowerCase(java.util.Locale.US);
74      }
75  }