Class EmptyForInitializerPadCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class EmptyForInitializerPadCheck
    extends AbstractCheck

    Checks the padding of an empty for initializer; that is whether a space is required at an empty for initializer, or such spaces are forbidden. No check occurs if there is a line wrap at the initializer, as in

    for (
          ; i < j; i++, j--)
       

    The policy to verify is specified using the PadOption class and defaults to PadOption.NOSPACE.

    An example of how to configure the check is:

     <module name="EmptyForInitializerPad"/>
     
    • Field Detail

      • MSG_PRECEDED

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

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

        private static final java.lang.String SEMICOLON
        Semicolon literal.
        See Also:
        Constant Field Values
      • option

        private PadOption option
        The policy to enforce.
    • Constructor Detail

      • EmptyForInitializerPadCheck

        public EmptyForInitializerPadCheck()
    • 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