Class Modifier

java.lang.Object

java.lang.reflect.Modifier

public final class Modifier
extends Object

The Modifier class provides static methods and constants to decode class and member access modifiers. The AccessFlag class should be used instead of this class. The sets of modifiers are represented as integers with non-distinct bit positions representing different modifiers. The values for the constants representing the modifiers are taken from the tables in sections 4.1, 4.4, 4.5, and 4.7 of The Java Virtual Machine Specification.

API Note:

Not all modifiers that are syntactic Java language modifiers are represented in this class, only those modifiers that also have a corresponding JVM access flag are included. In particular, the default method modifier (JLS 9.4.3) and the value, sealed and non-sealed class (JLS 8.1.1.2) and interface (JLS 9.1.1.4) modifiers are not represented in this class.

Since:

1.1

See Also:

• Class.getModifiers()
• Member.getModifiers()

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ABSTRACT	The int value representing the abstract modifier.
static final int	FINAL	The int value representing the final modifier.
static final int	IDENTITY	Preview. The int value representing the ACC_IDENTITY modifier.
static final int	INTERFACE	The int value representing the interface modifier.
static final int	NATIVE	The int value representing the native modifier.
static final int	PRIVATE	The int value representing the private modifier.
static final int	PROTECTED	The int value representing the protected modifier.
static final int	PUBLIC	The int value representing the public modifier.
static final int	STATIC	The int value representing the static modifier.
static final int	STRICT	The int value representing the strictfp modifier.
static final int	SYNCHRONIZED	The int value representing the synchronized modifier.
static final int	TRANSIENT	The int value representing the transient modifier.
static final int	VOLATILE	The int value representing the volatile modifier.

Method Summary

Modifier and Type	Method	Description
static int	classModifiers()	Return an int value OR-ing together the source language modifiers that can be applied to a class.
static int	constructorModifiers()	Return an int value OR-ing together the source language modifiers that can be applied to a constructor.
static int	fieldModifiers()	Return an int value OR-ing together the source language modifiers that can be applied to a field.
static int	interfaceModifiers()	Return an int value OR-ing together the source language modifiers that can be applied to an interface.
static boolean	isAbstract(int mod)	Return true if the integer argument includes the abstract modifier, false otherwise.
static boolean	isFinal(int mod)	Return true if the integer argument includes the final modifier, false otherwise.
static boolean	isIdentity(int mod)	Preview. Return true if the integer argument includes the identity modifier, false otherwise.
static boolean	isInterface(int mod)	Return true if the integer argument includes the interface modifier, false otherwise.
static boolean	isNative(int mod)	Return true if the integer argument includes the native modifier, false otherwise.
static boolean	isPrivate(int mod)	Return true if the integer argument includes the private modifier, false otherwise.
static boolean	isProtected(int mod)	Return true if the integer argument includes the protected modifier, false otherwise.
static boolean	isPublic(int mod)	Return true if the integer argument includes the public modifier, false otherwise.
static boolean	isStatic(int mod)	Return true if the integer argument includes the static modifier, false otherwise.
static boolean	isStrict(int mod)	Return true if the integer argument includes the strictfp modifier, false otherwise.
static boolean	isSynchronized(int mod)	Return true if the integer argument includes the synchronized modifier, false otherwise.
static boolean	isTransient(int mod)	Return true if the integer argument includes the transient modifier, false otherwise.
static boolean	isVolatile(int mod)	Return true if the integer argument includes the volatile modifier, false otherwise.
static int	methodModifiers()	Return an int value OR-ing together the source language modifiers that can be applied to a method.
static int	parameterModifiers()	Return an int value OR-ing together the source language modifiers that can be applied to a parameter.
static String	toString(int mod)	Return a string describing the access modifier flags in the specified modifier.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

PUBLIC

public static final int PUBLIC

The int value representing the public modifier.

See Also:

• AccessFlag.PUBLIC
• Constant Field Values

PRIVATE

public static final int PRIVATE

The int value representing the private modifier.

See Also:

• AccessFlag.PRIVATE
• Constant Field Values

PROTECTED

public static final int PROTECTED

The int value representing the protected modifier.

See Also:

• AccessFlag.PROTECTED
• Constant Field Values

STATIC

public static final int STATIC

The int value representing the static modifier.

See Also:

• AccessFlag.STATIC
• Constant Field Values

FINAL

public static final int FINAL

The int value representing the final modifier.

See Also:

• AccessFlag.FINAL
• Constant Field Values

SYNCHRONIZED

public static final int SYNCHRONIZED

The int value representing the synchronized modifier.

See Also:

• AccessFlag.SYNCHRONIZED
• Constant Field Values

IDENTITY

public static final int IDENTITY

IDENTITY is a reflective preview API of the Java platform.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

The int value representing the ACC_IDENTITY modifier.

Since:

Valhalla

See Also:

• Constant Field Values

VOLATILE

public static final int VOLATILE

The int value representing the volatile modifier.

See Also:

• AccessFlag.VOLATILE
• Constant Field Values

TRANSIENT

public static final int TRANSIENT

The int value representing the transient modifier.

See Also:

• AccessFlag.TRANSIENT
• Constant Field Values

NATIVE

public static final int NATIVE

The int value representing the native modifier.

See Also:

• AccessFlag.NATIVE
• Constant Field Values

INTERFACE

public static final int INTERFACE

The int value representing the interface modifier.

See Also:

• AccessFlag.INTERFACE
• Constant Field Values

ABSTRACT

public static final int ABSTRACT

The int value representing the abstract modifier.

See Also:

• AccessFlag.ABSTRACT
• Constant Field Values

STRICT

public static final int STRICT

The int value representing the strictfp modifier.

See Also:

• AccessFlag.STRICT
• Constant Field Values

Method Details

isPublic

public static boolean isPublic(int mod)

Return true if the integer argument includes the public modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the public modifier; false otherwise.

isPrivate

public static boolean isPrivate(int mod)

Return true if the integer argument includes the private modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the private modifier; false otherwise.

isProtected

public static boolean isProtected(int mod)

Return true if the integer argument includes the protected modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the protected modifier; false otherwise.

isStatic

public static boolean isStatic(int mod)

Return true if the integer argument includes the static modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the static modifier; false otherwise.

isFinal

public static boolean isFinal(int mod)

Return true if the integer argument includes the final modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the final modifier; false otherwise.

isSynchronized

public static boolean isSynchronized(int mod)

Return true if the integer argument includes the synchronized modifier, false otherwise.

API Note:

isSynchronized should only be called with the modifiers of a method.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the synchronized modifier; false otherwise.

isIdentity

public static boolean isIdentity(int mod)

isIdentity is a reflective preview API of the Java platform.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

Return true if the integer argument includes the identity modifier, false otherwise.

API Note:

isIdentity should only be called with the modifiers of a class.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the identity modifier; false otherwise.

Since:

Valhalla

isVolatile

public static boolean isVolatile(int mod)

Return true if the integer argument includes the volatile modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the volatile modifier; false otherwise.

isTransient

public static boolean isTransient(int mod)

Return true if the integer argument includes the transient modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the transient modifier; false otherwise.

isNative

public static boolean isNative(int mod)

Return true if the integer argument includes the native modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the native modifier; false otherwise.

isInterface

public static boolean isInterface(int mod)

Return true if the integer argument includes the interface modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the interface modifier; false otherwise.

isAbstract

public static boolean isAbstract(int mod)

Return true if the integer argument includes the abstract modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the abstract modifier; false otherwise.

isStrict

public static boolean isStrict(int mod)

Return true if the integer argument includes the strictfp modifier, false otherwise.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the strictfp modifier; false otherwise.

toString

public static String toString(int mod)

Return a string describing the access modifier flags in the specified modifier. For example:

   public final synchronized

The modifier names are returned in an order consistent with the suggested modifier orderings given in sections 8.1.1, 8.3.1, 8.4.3, 8.8.3, and 9.1.1 of The Java Language Specification. The full modifier ordering used by this method is:

public protected private abstract static final transient volatile synchronized native strictfp interface

The interface modifier discussed in this class is not a true modifier in the Java language and it appears after all other modifiers listed by this method. This method may return a string of modifiers that are not valid modifiers of a Java entity; in other words, no checking is done on the possible validity of the combination of modifiers represented by the input. Note that to perform such checking for a known kind of entity, such as a constructor or method, first AND the argument of toString with the appropriate mask from a method like constructorModifiers() or methodModifiers().

API Note:

To make a high-fidelity representation of the Java source modifiers of a class or member, source-level modifiers that do not have a constant in this class should be included and appear in an order consistent with the full recommended ordering for that kind of declaration as given in The Java Language Specification. For example, for a method the "default" modifier is ordered immediately before "static" (JLS 9.4). For a class object, the "sealed" or "non-sealed" modifier is ordered immediately after "final" for a class (JLS 8.1.1) and immediately after "static" for an interface (JLS 9.1.1).

Parameters:

mod - a set of modifiers

Returns:

a string representation of the set of modifiers represented by mod

classModifiers

public static int classModifiers()

Return an int value OR-ing together the source language modifiers that can be applied to a class.

Returns:

an int value OR-ing together the source language modifiers that can be applied to a class.

See Java Language Specification:

8.1.1 Class Modifiers

Since:

1.7

See Also:

• AccessFlag.Location.CLASS
• AccessFlag.Location.INNER_CLASS

interfaceModifiers

public static int interfaceModifiers()

Return an int value OR-ing together the source language modifiers that can be applied to an interface.

Returns:

an int value OR-ing together the source language modifiers that can be applied to an interface.

See Java Language Specification:

9.1.1 Interface Modifiers

Since:

1.7

See Also:

• AccessFlag.Location.CLASS
• AccessFlag.Location.INNER_CLASS

constructorModifiers

public static int constructorModifiers()

Return an int value OR-ing together the source language modifiers that can be applied to a constructor.

Returns:

an int value OR-ing together the source language modifiers that can be applied to a constructor.

See Java Language Specification:

8.8.3 Constructor Modifiers

Since:

1.7

See Also:

• AccessFlag.Location.METHOD

methodModifiers

public static int methodModifiers()

Return an int value OR-ing together the source language modifiers that can be applied to a method.

Returns:

an int value OR-ing together the source language modifiers that can be applied to a method.

See Java Language Specification:

8.4.3 Method Modifiers

Since:

1.7

See Also:

• AccessFlag.Location.METHOD

fieldModifiers

public static int fieldModifiers()

Return an int value OR-ing together the source language modifiers that can be applied to a field.

Returns:

an int value OR-ing together the source language modifiers that can be applied to a field.

See Java Language Specification:

8.3.1 Field Modifiers

Since:

1.7

See Also:

• AccessFlag.Location.FIELD

parameterModifiers

public static int parameterModifiers()

Return an int value OR-ing together the source language modifiers that can be applied to a parameter.

Returns:

an int value OR-ing together the source language modifiers that can be applied to a parameter.

See Java Language Specification:

8.4.1 Formal Parameters

Since:

1.8

See Also:

• AccessFlag.Location.METHOD_PARAMETER