Class Modifier

java.lang.Object
java.lang.reflect.Modifier

public final classModifierextendsObject
The Modifier class providesstatic methods andconstants to decode class and member access modifiers. The sets ofmodifiers are represented as integers with distinct bit positionsrepresenting different modifiers. The values for the constantsrepresenting the modifiers are taken from the tables in sections4.1,4.4,4.5, and4.7 ofThe Java Virtual Machine Specification.
API Note:
Not all modifiers that are syntactic Java language modifiers arerepresented in this class, only those modifiers thatalsohave a corresponding JVMaccess flag areincluded. In particular thedefault method modifier (JLS9.4.3) and thesealed andnon-sealed class(JLS8.1.1.2) and interface (JLS9.1.1.4) modifiersarenot represented in this class.
Since:
1.1
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Theint value representing theabstractmodifier.
    static final int
    Theint value representing thefinalmodifier.
    static final int
    Theint value representing theinterfacemodifier.
    static final int
    Theint value representing thenativemodifier.
    static final int
    Theint value representing theprivatemodifier.
    static final int
    Theint value representing theprotectedmodifier.
    static final int
    Theint value representing thepublicmodifier.
    static final int
    Theint value representing thestaticmodifier.
    static final int
    Theint value representing thestrictfpmodifier.
    static final int
    Theint value representing thesynchronizedmodifier.
    static final int
    Theint value representing thetransientmodifier.
    static final int
    Theint value representing thevolatilemodifier.
  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    Return anint value OR-ing together the source languagemodifiers that can be applied to a class.
    static int
    Return anint value OR-ing together the source languagemodifiers that can be applied to a constructor.
    static int
    Return anint value OR-ing together the source languagemodifiers that can be applied to a field.
    static int
    Return anint value OR-ing together the source languagemodifiers that can be applied to an interface.
    static boolean
    isAbstract(int mod)
    Returntrue if the integer argument includes theabstract modifier,false otherwise.
    static boolean
    isFinal(int mod)
    Returntrue if the integer argument includes thefinal modifier,false otherwise.
    static boolean
    isInterface(int mod)
    Returntrue if the integer argument includes theinterface modifier,false otherwise.
    static boolean
    isNative(int mod)
    Returntrue if the integer argument includes thenative modifier,false otherwise.
    static boolean
    isPrivate(int mod)
    Returntrue if the integer argument includes theprivate modifier,false otherwise.
    static boolean
    isProtected(int mod)
    Returntrue if the integer argument includes theprotected modifier,false otherwise.
    static boolean
    isPublic(int mod)
    Returntrue if the integer argument includes thepublic modifier,false otherwise.
    static boolean
    isStatic(int mod)
    Returntrue if the integer argument includes thestatic modifier,false otherwise.
    static boolean
    isStrict(int mod)
    Returntrue if the integer argument includes thestrictfp modifier,false otherwise.
    static boolean
    isSynchronized(int mod)
    Returntrue if the integer argument includes thesynchronized modifier,false otherwise.
    static boolean
    isTransient(int mod)
    Returntrue if the integer argument includes thetransient modifier,false otherwise.
    static boolean
    isVolatile(int mod)
    Returntrue if the integer argument includes thevolatile modifier,false otherwise.
    static int
    Return anint value OR-ing together the source languagemodifiers that can be applied to a method.
    static int
    Return anint value OR-ing together the source languagemodifiers that can be applied to a parameter.
    staticString
    toString(int mod)
    Return a string describing the access modifier flags inthe specified modifier.
  • Field Details

  • Method Details

    • isPublic

      public static boolean isPublic(int mod)
      Returntrue if the integer argument includes thepublic modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes thepublic modifier;false otherwise.
    • isPrivate

      public static boolean isPrivate(int mod)
      Returntrue if the integer argument includes theprivate modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes theprivate modifier;false otherwise.
    • isProtected

      public static boolean isProtected(int mod)
      Returntrue if the integer argument includes theprotected modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes theprotected modifier;false otherwise.
    • isStatic

      public static boolean isStatic(int mod)
      Returntrue if the integer argument includes thestatic modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes thestatic modifier;false otherwise.
    • isFinal

      public static boolean isFinal(int mod)
      Returntrue if the integer argument includes thefinal modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes thefinal modifier;false otherwise.
    • isSynchronized

      public static boolean isSynchronized(int mod)
      Returntrue if the integer argument includes thesynchronized modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes thesynchronized modifier;false otherwise.
    • isVolatile

      public static boolean isVolatile(int mod)
      Returntrue if the integer argument includes thevolatile modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes thevolatile modifier;false otherwise.
    • isTransient

      public static boolean isTransient(int mod)
      Returntrue if the integer argument includes thetransient modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes thetransient modifier;false otherwise.
    • isNative

      public static boolean isNative(int mod)
      Returntrue if the integer argument includes thenative modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes thenative modifier;false otherwise.
    • isInterface

      public static boolean isInterface(int mod)
      Returntrue if the integer argument includes theinterface modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes theinterface modifier;false otherwise.
    • isAbstract

      public static boolean isAbstract(int mod)
      Returntrue if the integer argument includes theabstract modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes theabstract modifier;false otherwise.
    • isStrict

      public static boolean isStrict(int mod)
      Returntrue if the integer argument includes thestrictfp modifier,false otherwise.
      Parameters:
      mod - a set of modifiers
      Returns:
      true ifmod includes thestrictfp modifier;false otherwise.
    • toString

      public static String toString(int mod)
      Return a string describing the access modifier flags inthe specified modifier. For example:
         public final synchronized strictfp
      The modifier names are returned in an order consistent with thesuggested modifier orderings given in sections 8.1.1, 8.3.1, 8.4.3, 8.8.3, and 9.1.1 ofThe Java Language Specification.The full modifier ordering used by this method is:
      public protected private abstract static final transientvolatile synchronized native strictfpinterface
      Theinterface modifier discussed in this class isnot a true modifier in the Java language and it appears afterall other modifiers listed by this method. This method mayreturn a string of modifiers that are not valid modifiers of aJava entity; in other words, no checking is done on thepossible validity of the combination of modifiers representedby the input.Note that to perform such checking for a known kind of entity,such as a constructor or method, first AND the argument oftoString with the appropriate mask from a method likeconstructorModifiers() ormethodModifiers().
      API Note:
      To make a high-fidelity representation of the Java sourcemodifiers of a class or member, source-level modifiers that donot have a constant in this class should be includedand appear in an order consistent with the full recommendedordering for that kind of declaration as given inTheJava Language Specification. For example, for amethod the "default" modifier is ordered immediatelybefore "static" (JLS9.4). For aclass object, the "sealed" or"non-sealed" modifier isordered immediately after "final" for a class (JLS8.1.1) and immediately after "static" for aninterface (JLS9.1.1).
      Parameters:
      mod - a set of modifiers
      Returns:
      a string representation of the set of modifiersrepresented bymod
    • classModifiers

      public static int classModifiers()
      Return anint value OR-ing together the source languagemodifiers that can be applied to a class.
      Returns:
      anint value OR-ing together the source languagemodifiers that can be applied to a class.
      SeeJava Language Specification:
      8.1.1 Class Modifiers
      Since:
      1.7
      See Also:
    • interfaceModifiers

      public static int interfaceModifiers()
      Return anint value OR-ing together the source languagemodifiers that can be applied to an interface.
      Returns:
      anint value OR-ing together the source languagemodifiers that can be applied to an interface.
      SeeJava Language Specification:
      9.1.1 Interface Modifiers
      Since:
      1.7
      See Also:
    • constructorModifiers

      public static int constructorModifiers()
      Return anint value OR-ing together the source languagemodifiers that can be applied to a constructor.
      Returns:
      anint value OR-ing together the source languagemodifiers that can be applied to a constructor.
      SeeJava Language Specification:
      8.8.3 Constructor Modifiers
      Since:
      1.7
      See Also:
    • methodModifiers

      public static int methodModifiers()
      Return anint value OR-ing together the source languagemodifiers that can be applied to a method.
      Returns:
      anint value OR-ing together the source languagemodifiers that can be applied to a method.
      SeeJava Language Specification:
      8.4.3 Method Modifiers
      Since:
      1.7
      See Also:
    • fieldModifiers

      public static int fieldModifiers()
      Return anint value OR-ing together the source languagemodifiers that can be applied to a field.
      Returns:
      anint value OR-ing together the source languagemodifiers that can be applied to a field.
      SeeJava Language Specification:
      8.3.1 Field Modifiers
      Since:
      1.7
      See Also:
    • parameterModifiers

      public static int parameterModifiers()
      Return anint value OR-ing together the source languagemodifiers that can be applied to a parameter.
      Returns:
      anint value OR-ing together the source languagemodifiers that can be applied to a parameter.
      SeeJava Language Specification:
      8.4.1 Formal Parameters
      Since:
      1.8
      See Also: