Package com.puppycrawl.tools.checkstyle.checks.modifier

Class ModifierOrderCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class ModifierOrderCheck
extends AbstractCheck

    Checks that the order of modifiers conforms to the suggestions in the Java Language specification, § 8.1.1, 8.3.1, 8.4.3 and 9.4. The correct order is:

    1. public
    2. protected
    3. private
    4. abstract
    5. default
    6. static
    7. final
    8. transient
    9. volatile
    10. synchronized
    11. native
    12. strictfp

    In additional, modifiers are checked to ensure all annotations are declared before all other modifiers.

    Rationale: Code is easier to read if everybody follows a standard.

    ATTENTION: We skip type annotations from validation.

    To configure the check: 

     <module name="ModifierOrder"/>

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • annotation.order
    • mod.order
    Since:
    3.0

    • Field Detail

      • MSG_ANNOTATION_ORDER

        public static final java.lang.String MSG_ANNOTATION_ORDER
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • MSG_MODIFIER_ORDER

        public static final java.lang.String MSG_MODIFIER_ORDER
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ModifierOrderCheck

        public ModifierOrderCheck()

    • Method Detail

      • getDefaultTokens

        public int[] getDefaultTokens()
        Description copied from class: AbstractCheck
        Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
        Specified by:
        getDefaultTokens in class AbstractCheck
        Returns:
        the default tokens
        See Also:
        TokenTypes

      • getAcceptableTokens

        public int[] getAcceptableTokens()
        Description copied from class: AbstractCheck
        The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
        Specified by:
        getAcceptableTokens in class AbstractCheck
        Returns:
        the token set this check is designed for.
        See Also:
        TokenTypes

      • getRequiredTokens

        public int[] getRequiredTokens()
        Description copied from class: AbstractCheck
        The tokens that this check must be registered for.
        Specified by:
        getRequiredTokens in class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes