GrepCode: java.lang.reflect.Modifier (.java) - Class

JDK
/
jdk / openjdk
/
7-b147

7-b147
6-b14
/
java.lang.reflect.Modifier
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /*
2
   * Copyright (c) 1996, 2008, Oracle and/or its affiliates. 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.  Oracle designates this
8
   * particular file as subject to the "Classpath" exception as provided
9
   * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22
  * or visit www.oracle.com if you need additional information or have any
23
  * questions.
24
  */
25
 
26
 package java.lang.reflect;
27
 
28
 import java.security.AccessController;
29
 import sun.reflect.LangReflectAccess;
30
 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 tables in sections 4.1, 4.4, 4.5, and 4.7 of
 The Java™ Virtual Machine Specification.

 
 Author(s):Nakul SaraiyaKenneth Russell See also:java.lang.Class.getModifiers()Member.getModifiers()
45
 
46
 public
47
 class Modifier {
48
 
49
     /*
50
      * Bootstrapping protocol between java.lang and java.lang.reflect
51
      *  packages
52
      */
53
     static {
54
         sun.reflect.ReflectionFactory factory =
55
             AccessController.doPrivileged(
56
                 new ReflectionFactory.GetReflectionFactoryAction());
57
         factory.setLangReflectAccess(new java.lang.reflect.ReflectAccess());
58
     }

    
 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.
67
 
68
     public static boolean isPublic(int mod) {
69
         return (mod & PUBLIC) != 0;
70
     }

    
 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.
79
 
80
     public static boolean isPrivate(int mod) {
81
         return (mod & PRIVATE) != 0;
82
     }

    
 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.
91
 
92
     public static boolean isProtected(int mod) {
93
         return (mod & PROTECTED) != 0;
94
     }

    
 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.
103
104
    public static boolean isStatic(int mod) {
105
        return (mod & STATIC) != 0;
106
    }

    
 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.
115
116
    public static boolean isFinal(int mod) {
117
        return (mod & FINAL) != 0;
118
    }

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

 
 Parameters:mod a set of modifiers Returns:true if mod includes the
 synchronized modifier; false otherwise.
127
128
    public static boolean isSynchronized(int mod) {
129
        return (mod & SYNCHRONIZED) != 0;
130
    }

    
 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.
139
140
    public static boolean isVolatile(int mod) {
141
        return (mod & VOLATILE) != 0;
142
    }

    
 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.
151
152
    public static boolean isTransient(int mod) {
153
        return (mod & TRANSIENT) != 0;
154
    }

    
 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.
163
164
    public static boolean isNative(int mod) {
165
        return (mod & NATIVE) != 0;
166
    }

    
 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.
175
176
    public static boolean isInterface(int mod) {
177
        return (mod & INTERFACE) != 0;
178
    }

    
 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.
187
188
    public static boolean isAbstract(int mod) {
189
        return (mod & ABSTRACT) != 0;
190
    }

    
 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.
199
200
    public static boolean isStrict(int mod) {
201
        return (mod & STRICT) != 0;
202
    }

    
 Return a string describing the access modifier flags in
 the specified modifier. For example:
     public final synchronized strictfp
 
 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().

 
 Parameters:mod a set of modifiers Returns:a string representation of the set of modifiers
 represented by mod
234
235
    public static String toString(int mod) {
236
        StringBuffer sb = new StringBuffer();
237
        int len;
238
239
        if ((mod & PUBLIC) != 0)        sb.append("public ");
240
        if ((mod & PROTECTED) != 0)     sb.append("protected ");
241
        if ((mod & PRIVATE) != 0)       sb.append("private ");
242
243
        /* Canonical order */
244
        if ((mod & ABSTRACT) != 0)      sb.append("abstract ");
245
        if ((mod & STATIC) != 0)        sb.append("static ");
246
        if ((mod & FINAL) != 0)         sb.append("final ");
247
        if ((mod & TRANSIENT) != 0)     sb.append("transient ");
248
        if ((mod & VOLATILE) != 0)      sb.append("volatile ");
249
        if ((mod & SYNCHRONIZED) != 0)  sb.append("synchronized ");
250
        if ((mod & NATIVE) != 0)        sb.append("native ");
251
        if ((mod & STRICT) != 0)        sb.append("strictfp ");
252
        if ((mod & INTERFACE) != 0)     sb.append("interface ");
253
254
        if ((len = sb.length()) > 0)    /* trim trailing space */
255
            return sb.toString().substring(0, len-1);
256
        return "";
257
    }
258
259
    /*
260
     * Access modifier flag constants from tables 4.1, 4.4, 4.5, and 4.7 of
261
     * <cite>The Java&trade; Virtual Machine Specification</cite>
262
     */

    
 The int value representing the public
 modifier.
 
267
268
    public static final int PUBLIC           = 0x00000001;

    
 The int value representing the private
 modifier.
 
273
274
    public static final int PRIVATE          = 0x00000002;

    
 The int value representing the protected
 modifier.
 
279
280
    public static final int PROTECTED        = 0x00000004;

    
 The int value representing the static
 modifier.
 
285
286
    public static final int STATIC           = 0x00000008;

    
 The int value representing the final
 modifier.
 
291
292
    public static final int FINAL            = 0x00000010;

    
 The int value representing the synchronized
 modifier.
 
297
298
    public static final int SYNCHRONIZED     = 0x00000020;

    
 The int value representing the volatile
 modifier.
 
303
304
    public static final int VOLATILE         = 0x00000040;

    
 The int value representing the transient
 modifier.
 
309
310
    public static final int TRANSIENT        = 0x00000080;

    
 The int value representing the native
 modifier.
 
315
316
    public static final int NATIVE           = 0x00000100;

    
 The int value representing the interface
 modifier.
 
321
322
    public static final int INTERFACE        = 0x00000200;

    
 The int value representing the abstract
 modifier.
 
327
328
    public static final int ABSTRACT         = 0x00000400;

    
 The int value representing the strictfp
 modifier.
 
333
334
    public static final int STRICT           = 0x00000800;
335
336
    // Bits not (yet) exposed in the public API either because they
337
    // have different meanings for fields and methods and there is no
338
    // way to distinguish between the two in this class, or because
339
    // they are not Java programming language keywords
340
    static final int BRIDGE    = 0x00000040;
341
    static final int VARARGS   = 0x00000080;
342
    static final int SYNTHETIC = 0x00001000;
343
    static final int ANNOTATION= 0x00002000;
344
    static final int ENUM      = 0x00004000;
345
    static boolean isSynthetic(int mod) {
346
      return (mod & SYNTHETIC) != 0;
347
    }

    
 See JLSv3 section 8.1.1.
 
351
352
    private static final int CLASS_MODIFIERS =
353
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE |
354
        Modifier.ABSTRACT       | Modifier.STATIC       | Modifier.FINAL   |
355
        Modifier.STRICT;

    
 See JLSv3 section 9.1.1.
 
359
360
    private static final int INTERFACE_MODIFIERS =
361
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE |
362
        Modifier.ABSTRACT       | Modifier.STATIC       | Modifier.STRICT;


    
 See JLSv3 section 8.8.3.
 
367
368
    private static final int CONSTRUCTOR_MODIFIERS =
369
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE;

    
 See JLSv3 section 8.4.3.
 
373
374
    private static final int METHOD_MODIFIERS =
375
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE |
376
        Modifier.ABSTRACT       | Modifier.STATIC       | Modifier.FINAL   |
377
        Modifier.SYNCHRONIZED   | Modifier.NATIVE       | Modifier.STRICT;

    
 See JLSv3 section 8.3.1.
 
381
382
    private static final int FIELD_MODIFIERS =
383
        Modifier.PUBLIC         | Modifier.PROTECTED    | Modifier.PRIVATE |
384
        Modifier.STATIC         | Modifier.FINAL        | Modifier.TRANSIENT |
385
        Modifier.VOLATILE;

    
 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. Since:1.7Jls:8.1.1 Class Modifiers
395
396
    public static int classModifiers() {
397
        return CLASS_MODIFIERS;
398
    }

    
 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 inteface. Since:1.7Jls:9.1.1 Interface Modifiers
408
409
    public static int interfaceModifiers() {
410
        return INTERFACE_MODIFIERS;
411
    }

    
 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. Since:1.7Jls:8.8.3 Constructor Modifiers
421
422
    public static int constructorModifiers() {
423
        return CONSTRUCTOR_MODIFIERS;
424
    }

    
 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. Since:1.7Jls:8.4.3 Method Modifiers
434
435
    public static int methodModifiers() {
436
        return METHOD_MODIFIERS;
437
    }


    
 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. Since:1.7Jls:8.3.1 Field Modifiers
448
449
    public static int fieldModifiers() {
450
        return FIELD_MODIFIERS;
451
    }
452
}