Package com.puppycrawl.tools.checkstyle.checks.coding

Class MultipleVariableDeclarationsCheck

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

    Checks that each variable declaration is in its own statement and on its own line.

    Rationale: the Java code conventions chapter 6.1 recommends that declarations should be one per line/statement.

    To configure the check: 

     <module name="MultipleVariableDeclarations"/>

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • multiple.variable.declarations
    • multiple.variable.declarations.comma
    Since:
    3.4

    • Field Detail

      • MSG_MULTIPLE

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

      • MSG_MULTIPLE_COMMA

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

    • Constructor Detail

      • MultipleVariableDeclarationsCheck

        public MultipleVariableDeclarationsCheck()

    • Method Detail

      • 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

      • 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

      • 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