Package com.puppycrawl.tools.checkstyle.checks.whitespace

Class NoWhitespaceAfterCheck

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

    Checks that there is no whitespace after a token. More specifically, it checks that it is not followed by whitespace, or (if linebreaks are allowed) all characters on the line after are whitespace. To forbid linebreaks after a token, set property allowLineBreaks to false.

    By default the check will check the following operators: ARRAY_INIT, AT, BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS, TYPECAST, ARRAY_DECLARATOR, INDEX_OP.

    The check processes ARRAY_DECLARATOR, INDEX_OP specially from other tokens. Actually it is checked that there is no whitespace before this tokens, not after them. Spaces after the ANNOTATIONS before ARRAY_DECLARATOR and INDEX_OP will be ignored.

    An example of how to configure the check is: 

     <module name="NoWhitespaceAfter"/>

    An example of how to configure the check to forbid linebreaks after a DOT token is: 

     <module name="NoWhitespaceAfter">
     <property name="tokens" value="DOT"/>
     <property name="allowLineBreaks" value="false"/>
 </module>

    If the annotation is between the type and the array, the check will skip validation for spaces: 

     public void foo(final char @NotNull [] param) {} // No violation

    • Field Detail

      • MSG_KEY

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

    • Constructor Detail

      • NoWhitespaceAfterCheck

        public NoWhitespaceAfterCheck()

    • 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

      • setAllowLineBreaks

        public void setAllowLineBreaks​(boolean allowLineBreaks)
        Control whether whitespace is flagged at linebreaks.
        Parameters:
        allowLineBreaks - whether whitespace should be flagged at linebreaks.