Class LeftCurlyCheck

    • Field Detail

      • MSG_KEY_LINE_NEW

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

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

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

        private static final java.lang.String OPEN_CURLY_BRACE
        Open curly brace literal.
        See Also:
        Constant Field Values
      • ignoreEnums

        private boolean ignoreEnums
        If true, Check will ignore enums.
    • Constructor Detail

      • LeftCurlyCheck

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

        @Deprecated
        public void setMaxLineLength​(int maxLineLength)
        Deprecated.
        since 6.10 release, option is not required for the Check.
        Sets the maximum line length used in calculating the placement of the left curly brace.
        Parameters:
        maxLineLength - the max allowed line length
      • setIgnoreEnums

        public void setIgnoreEnums​(boolean ignoreEnums)
        Sets whether check should ignore enums when left curly brace policy is EOL.
        Parameters:
        ignoreEnums - check's option for ignoring enums.
      • 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
      • skipAnnotationOnlyLines

        private static DetailAST skipAnnotationOnlyLines​(DetailAST ast)
        Skip lines that only contain TokenTypes.ANNOTATIONs. If the received DetailAST has annotations within its modifiers then first token on the line of the first token after all annotations is return. This might be an annotation. Otherwise, the received DetailAST is returned.
        Parameters:
        ast - DetailAST.
        Returns:
        DetailAST.
      • getFirstAnnotationOnSameLine

        private static DetailAST getFirstAnnotationOnSameLine​(DetailAST annotation)
        Returns first annotation on same line.
        Parameters:
        annotation - last annotation on the line
        Returns:
        first annotation on same line.
      • findLastAnnotation

        private static DetailAST findLastAnnotation​(DetailAST modifiers)
        Find the last token of type TokenTypes.ANNOTATION under the given set of modifiers.
        Parameters:
        modifiers - DetailAST.
        Returns:
        DetailAST or null if there are no annotations.
      • verifyBrace

        private void verifyBrace​(DetailAST brace,
                                 DetailAST startToken)
        Verifies that a specified left curly brace is placed correctly according to policy.
        Parameters:
        brace - token for left curly brace
        startToken - token for start of expression
      • validateEol

        private void validateEol​(DetailAST brace,
                                 java.lang.String braceLine)
        Validate EOL case.
        Parameters:
        brace - brace AST
        braceLine - line content
      • validateNewLinePosition

        private void validateNewLinePosition​(DetailAST brace,
                                             DetailAST startToken,
                                             java.lang.String braceLine)
        Validate token on new Line position.
        Parameters:
        brace - brace AST
        startToken - start Token
        braceLine - content of line with Brace
      • hasLineBreakAfter

        private boolean hasLineBreakAfter​(DetailAST leftCurly)
        Checks if left curly has line break after.
        Parameters:
        leftCurly - Left curly token.
        Returns:
        True, left curly has line break after.