/*
* Copyright (c) 2005, 2020, Oracle and/or its affiliates. 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.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.
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.
Note that it is possible additional modifiers will be added in
future versions of the platform.
Author: Joseph D. Darcy, Scott Seligman, Peter von der Ahé @jls 8.1.1 Class Modifiers @jls 8.3.1 Field Modifiers @jls 8.4.3 Method Modifiers @jls 8.8.3 Constructor Modifiers @jls 9.1.1 Interface Modifiers Since: 1.6
/**
* 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.
*
* @jls 8.1.1 Class Modifiers
* @jls 8.3.1 Field Modifiers
* @jls 8.4.3 Method Modifiers
* @jls 8.8.3 Constructor Modifiers
* @jls 9.1.1 Interface Modifiers
*
* @author Joseph D. Darcy
* @author Scott Seligman
* @author Peter von der Ahé
* @since 1.6
*/
public enum Modifier {
// Note java.lang.reflect.Modifier includes INTERFACE, but that's a VMism.
The modifier public /** The modifier {@code public} */ PUBLIC,
The modifier protected /** The modifier {@code protected} */ PROTECTED,
The modifier private /** The modifier {@code private} */ PRIVATE,
The modifier abstract /** The modifier {@code abstract} */ ABSTRACT,
The modifier default Since: 1.8
/**
* The modifier {@code default}
* @since 1.8
*/
DEFAULT,
The modifier static /** The modifier {@code static} */ STATIC,
{@preview Associated with sealed classes, a preview feature of the Java language.
This enum constant is associated with sealed classes, a preview feature of the Java language. Preview features may be removed in a future release, or upgraded to permanent features of the Java language.} The modifier sealed Since: 15
/**
* {@preview Associated with sealed classes, a preview feature of the Java language.
*
* This enum constant is associated with <i>sealed classes</i>, a preview
* feature of the Java language. Preview features
* may be removed in a future release, or upgraded to permanent
* features of the Java language.}
*
* The modifier {@code sealed}
* @since 15
*/
@jdk.internal.PreviewFeature(feature=jdk.internal.PreviewFeature.Feature.SEALED_CLASSES,
essentialAPI=false)
SEALED,
{@preview Associated with sealed classes, a preview feature of the Java language.
This enum constant is associated with sealed classes, a preview feature of the Java language. Preview features may be removed in a future release, or upgraded to permanent features of the Java language.} The modifier non-sealed Since: 15
/**
* {@preview Associated with sealed classes, a preview feature of the Java language.
*
* This enum constant is associated with <i>sealed classes</i>, a preview
* feature of the Java language. Preview features
* may be removed in a future release, or upgraded to permanent
* features of the Java language.}
*
* The modifier {@code non-sealed}
* @since 15
*/
@jdk.internal.PreviewFeature(feature=jdk.internal.PreviewFeature.Feature.SEALED_CLASSES,
essentialAPI=false)
NON_SEALED {
public String toString() {
return "non-sealed";
}
},
The modifier final /** The modifier {@code final} */ FINAL,
The modifier transient /** The modifier {@code transient} */ TRANSIENT,
The modifier volatile /** The modifier {@code volatile} */ VOLATILE,
The modifier synchronized /** The modifier {@code synchronized} */ SYNCHRONIZED,
The modifier native /** The modifier {@code native} */ NATIVE,
The modifier strictfp /** The modifier {@code strictfp} */ STRICTFP;
Returns this modifier's name as defined in The
Java Language Specification. The modifier name is the name of the enum
constant in lowercase and with any underscores ("_") replaced with hyphens ("-"). Returns: the modifier's name
/**
* Returns this modifier's name as defined in <cite>The
* Java Language Specification</cite>.
* The modifier name is the {@linkplain #name() name of the enum
* constant} in lowercase and with any underscores ("{@code _}")
* replaced with hyphens ("{@code -}").
* @return the modifier's name
*/
@Override
public String toString() {
return name().toLowerCase(java.util.Locale.US);
}
}