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

Class SeparatorWrapCheck

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

    Checks line wrapping with separators. The policy to verify is specified using the WrapOption class and defaults to WrapOption.EOL.

    By default the check will check the following separators: DOT, COMMA, Other acceptable tokens are SEMI, ELLIPSIS, AT, LPAREN, RPAREN, ARRAY_DECLARATOR, RBRACK,

    Code example for comma and dot at the new line: 

     s
    .isEmpty();
 foo(i
    ,s);

    An example of how to configure the check is: 

     <module name="SeparatorWrap"/>

    Code example for comma and dot at the previous line: 

     s.
    isEmpty();
 foo(i,
    s);

    An example of how to configure the check for comma at the new line is: 

     <module name="SeparatorWrap">
     <property name="tokens" value="COMMA"/>
     <property name="option" value="nl"/>
 </module>

    • Field Detail

      • MSG_LINE_PREVIOUS

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

      • MSG_LINE_NEW

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

    • Constructor Detail

      • SeparatorWrapCheck

        public SeparatorWrapCheck()

    • Method Detail

      • setOption

        public void setOption​(java.lang.String optionStr)
        Set the option to enforce.
        Parameters:
        optionStr - string to decode option from
        Throws:
        java.lang.IllegalArgumentException - if unable to decode

      • 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