/*

 * Copyright 2005-2006 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.lang.model.element;

/**

 * Represents a modifier on a program element such

 * as a class, method, or field.

 *

 * <p>Not all modifiers are applicable to all kinds of elements.

 * When two or more modifiers appear in the source code of an element

 * then it is customary, though not required, that they appear in the same

 * order as the constants listed in the detail section below.

 *

 * <p>Note that it is possible additional modifiers will be added in

 * future versions of the platform.

 *

 * @author Joseph D. Darcy

 * @author Scott Seligman

 * @author Peter von der Ahé

 * @since 1.6

 */

public enum Modifier {

    // See JLS2 sections 8.1.1, 8.3.1, 8.4.3, 8.8.3, and 9.1.1.

    // java.lang.reflect.Modifier includes INTERFACE, but that's a VMism.

    /** The modifier {@code public} */          PUBLIC,

    /** The modifier {@code protected} */       PROTECTED,

    /** The modifier {@code private} */         PRIVATE,

    /** The modifier {@code abstract} */        ABSTRACT,

    /** The modifier {@code static} */          STATIC,

    /** The modifier {@code final} */           FINAL,

    /** The modifier {@code transient} */       TRANSIENT,

    /** The modifier {@code volatile} */        VOLATILE,

    /** The modifier {@code synchronized} */    SYNCHRONIZED,

    /** The modifier {@code native} */          NATIVE,

    /** The modifier {@code strictfp} */        STRICTFP;

    private String lowercase = null;    // modifier name in lowercase

    /**

     * Returns this modifier's name in lowercase.

     */

    public String toString() {

        if (lowercase == null) {

           lowercase = name().toLowerCase(java.util.Locale.US);

        }

        return lowercase;

    }

}