Class EmptyBlockCheck

    • Field Detail

      • MSG_KEY_BLOCK_NO_STATEMENT

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

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

        private BlockOption option
        The policy to enforce.
    • Constructor Detail

      • EmptyBlockCheck

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

        protected boolean hasText​(DetailAST slistAST)
        Checks if SLIST token contains any text.
        Parameters:
        slistAST - a DetailAST value
        Returns:
        whether the SLIST token contains any text.
      • checkIsAllLinesAreWhitespace

        private static boolean checkIsAllLinesAreWhitespace​(java.lang.String[] lines,
                                                            int lineFrom,
                                                            int lineTo)
        Checks is all lines in array contain whitespaces only.
        Parameters:
        lines - array of lines
        lineFrom - check from this line number
        lineTo - check to this line numbers
        Returns:
        true if lines contain only whitespaces
      • findLeftCurly

        private static DetailAST findLeftCurly​(DetailAST ast)
        Calculates the left curly corresponding to the block to be checked.
        Parameters:
        ast - a DetailAST value
        Returns:
        the left curly corresponding to the block to be checked