/*
* @(#)Modifier.java 1.27 04/02/17
*
* Copyright 2004 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
package java.lang.reflect;
import java.security.AccessController;
import sun.reflect.LangReflectAccess;
import sun.reflect.ReflectionFactory;
/**
* The Modifier class provides static
methods and
* constants to decode class and member access modifiers. The sets of
* modifiers are represented as integers with distinct bit positions
* representing different modifiers. The values for the constants
* representing the modifiers are taken from The
* JavaTM Virtual Machine Specification, Second
* edition tables
* 4.1,
* 4.4,
* 4.5, and
* 4.7.
*
* @see Class#getModifiers()
* @see Member#getModifiers()
*
* @author Nakul Saraiya
* @author Kenneth Russell
*/
public
class Modifier {
/*
* Bootstrapping protocol between java.lang and java.lang.reflect
* packages
*/
static {
sun.reflect.ReflectionFactory factory =
(sun.reflect.ReflectionFactory) AccessController.doPrivileged(
new ReflectionFactory.GetReflectionFactoryAction()
);
factory.setLangReflectAccess(new java.lang.reflect.ReflectAccess());
}
/**
* Return true if the integer argument includes the
* public modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* public modifier; false otherwise.
*/
public static boolean isPublic(int mod) {
return (mod & PUBLIC) != 0;
}
/**
* Return true if the integer argument includes the
* private modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* private modifier; false otherwise.
*/
public static boolean isPrivate(int mod) {
return (mod & PRIVATE) != 0;
}
/**
* Return true if the integer argument includes the
* protected modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* protected modifier; false otherwise.
*/
public static boolean isProtected(int mod) {
return (mod & PROTECTED) != 0;
}
/**
* Return true if the integer argument includes the
* static modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* static modifier; false otherwise.
*/
public static boolean isStatic(int mod) {
return (mod & STATIC) != 0;
}
/**
* Return true if the integer argument includes the
* final modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* final modifier; false otherwise.
*/
public static boolean isFinal(int mod) {
return (mod & FINAL) != 0;
}
/**
* Return true if the integer argument includes the
* synchronized modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* synchronized modifier; false otherwise.
*/
public static boolean isSynchronized(int mod) {
return (mod & SYNCHRONIZED) != 0;
}
/**
* Return true if the integer argument includes the
* volatile modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* volatile modifier; false otherwise.
*/
public static boolean isVolatile(int mod) {
return (mod & VOLATILE) != 0;
}
/**
* Return true if the integer argument includes the
* transient modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* transient modifier; false otherwise.
*/
public static boolean isTransient(int mod) {
return (mod & TRANSIENT) != 0;
}
/**
* Return true if the integer argument includes the
* native modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* native modifier; false otherwise.
*/
public static boolean isNative(int mod) {
return (mod & NATIVE) != 0;
}
/**
* Return true if the integer argument includes the
* interface modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* interface modifier; false otherwise.
*/
public static boolean isInterface(int mod) {
return (mod & INTERFACE) != 0;
}
/**
* Return true if the integer argument includes the
* abstract modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* abstract modifier; false otherwise.
*/
public static boolean isAbstract(int mod) {
return (mod & ABSTRACT) != 0;
}
/**
* Return true if the integer argument includes the
* strictfp modifier, false otherwise.
*
* @param mod a set of modifiers
* @return true if mod
includes the
* strictfp modifier; false otherwise.
*/
public static boolean isStrict(int mod) {
return (mod & STRICT) != 0;
}
/**
* Return a string describing the access modifier flags in
* the specified modifier. For example:
*
* The modifier names are returned in an order consistent with the * suggested modifier orderings given in The * Java Language Specification, Second Edition sections * §8.1.1, * §8.3.1, * §8.4.3, * §8.8.3, and * §9.1.1. * The full modifier ordering used by this method is: ** public final synchronized strictfp *
* 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.
*
* @param mod a set of modifiers
* @return a string representation of the set of modifiers
* represented by mod
*/
public static String toString(int mod) {
StringBuffer sb = new StringBuffer();
int len;
if ((mod & PUBLIC) != 0) sb.append("public ");
if ((mod & PROTECTED) != 0) sb.append("protected ");
if ((mod & PRIVATE) != 0) sb.append("private ");
/* Canonical order */
if ((mod & ABSTRACT) != 0) sb.append("abstract ");
if ((mod & STATIC) != 0) sb.append("static ");
if ((mod & FINAL) != 0) sb.append("final ");
if ((mod & TRANSIENT) != 0) sb.append("transient ");
if ((mod & VOLATILE) != 0) sb.append("volatile ");
if ((mod & SYNCHRONIZED) != 0) sb.append("synchronized ");
if ((mod & NATIVE) != 0) sb.append("native ");
if ((mod & STRICT) != 0) sb.append("strictfp ");
if ((mod & INTERFACE) != 0) sb.append("interface ");
if ((len = sb.length()) > 0) /* trim trailing space */
return sb.toString().substring(0, len-1);
return "";
}
/*
* Access modifier flag constants from The Java Virtual
* Machine Specification, Second Edition, tables 4.1, 4.4,
* 4.5, and 4.7.
*/
/**
* The int
value representing the public
* modifier.
*/
public static final int PUBLIC = 0x00000001;
/**
* The int
value representing the private
* modifier.
*/
public static final int PRIVATE = 0x00000002;
/**
* The int
value representing the protected
* modifier.
*/
public static final int PROTECTED = 0x00000004;
/**
* The int
value representing the static
* modifier.
*/
public static final int STATIC = 0x00000008;
/**
* The int
value representing the final
* modifier.
*/
public static final int FINAL = 0x00000010;
/**
* The int
value representing the synchronized
* modifier.
*/
public static final int SYNCHRONIZED = 0x00000020;
/**
* The int
value representing the volatile
* modifier.
*/
public static final int VOLATILE = 0x00000040;
/**
* The int
value representing the transient
* modifier.
*/
public static final int TRANSIENT = 0x00000080;
/**
* The int
value representing the native
* modifier.
*/
public static final int NATIVE = 0x00000100;
/**
* The int
value representing the interface
* modifier.
*/
public static final int INTERFACE = 0x00000200;
/**
* The int
value representing the abstract
* modifier.
*/
public static final int ABSTRACT = 0x00000400;
/**
* The int
value representing the strictfp
* modifier.
*/
public static final int STRICT = 0x00000800;
// Bits not (yet) exposed in the public API either because they
// have different meanings for fields and methods and there is no
// way to distinguish between the two in this class, or because
// they are not Java programming language keywords
static final int BRIDGE = 0x00000040;
static final int VARARGS = 0x00000080;
static final int SYNTHETIC = 0x00001000;
static final int ANNOTATION= 0x00002000;
static final int ENUM = 0x00004000;
static boolean isSynthetic(int mod) {
return (mod & SYNTHETIC) != 0;
}
}