1 /*
   2  * Copyright 2004 Sun Microsystems, Inc.  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.  Sun designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * 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 com.sun.mirror.declaration;
  27 
  28 
  29 /**
  30  * Represents a modifier on the declaration of a program element such
  31  * as a class, method, or field.
  32  *
  33  * <p> Not all modifiers are applicable to all kinds of declarations.
  34  * When two or more modifiers appear in the source code of a declaration,
  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  * @author Joseph D. Darcy
  39  * @author Scott Seligman
  40  * @since 1.5
  41  */
  42 
  43 public enum Modifier {
  44 
  45     // See JLS2 sections 8.1.1, 8.3.1, 8.4.3, 8.8.3, and 9.1.1.
  46     // java.lang.reflect.Modifier includes INTERFACE, but that's a VMism.
  47 
  48     /** The modifier <tt>public</tt> */         PUBLIC,
  49     /** The modifier <tt>protected</tt> */      PROTECTED,
  50     /** The modifier <tt>private</tt> */        PRIVATE,
  51     /** The modifier <tt>abstract</tt> */       ABSTRACT,
  52     /** The modifier <tt>static</tt> */         STATIC,
  53     /** The modifier <tt>final</tt> */          FINAL,
  54     /** The modifier <tt>transient</tt> */      TRANSIENT,
  55     /** The modifier <tt>volatile</tt> */       VOLATILE,
  56     /** The modifier <tt>synchronized</tt> */   SYNCHRONIZED,
  57     /** The modifier <tt>native</tt> */         NATIVE,
  58     /** The modifier <tt>strictfp</tt> */       STRICTFP;
  59 
  60 
  61     private String lowercase = null;    // modifier name in lowercase
  62 
  63     /**
  64      * Returns this modifier's name in lowercase.
  65      */
  66     public String toString() {
  67         if (lowercase == null) {
  68            lowercase = name().toLowerCase(java.util.Locale.US);
  69         }
  70         return lowercase;
  71     }
  72 }