Class BlockCommentEndPositionCheck

All Implemented Interfaces:
Configurable, Contextualizable

public class BlockCommentEndPositionCheck extends AbstractCheck
Checks that the Javadoc block comment end delimiter position is either alone on its own line or on the same line as the block comment begin /**.

It is possible to enforce two different strategies:

  • alone - The block comment end must be alone on its own line. This allows only multi-line Javadoc comments:
    
     /**
      * Multiple lines of Javadoc text are written here,
      * wrapped normally...
      */
     public void method();
     
  • alone_or_singleline - The block comment end must be either alone on its own line or on the same line as the block comment begin. This allows multi-line Javadoc as well as single-line Javadoc comments:
    
     // Block comment end is alone on its own line
     /**
      * Multiple lines of Javadoc text are written here,
      * wrapped normally...
      */
     public void method();
    
     // Single-line Javadoc
     /** Javadoc summary. */
     public void method1();
     
Since:
14.4.0
  • Field Details

    • MSG_BLOCK_COMMENT_END

      public static final String MSG_BLOCK_COMMENT_END
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:
    • strategy

      Specify the strategy policy for the block comment end position.
  • Constructor Details

    • BlockCommentEndPositionCheck

      public BlockCommentEndPositionCheck()
      Creates a new BlockCommentEndPositionCheck instance.
  • Method Details

    • 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:
    • 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:
    • 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:
    • isCommentNodesRequired

      public boolean isCommentNodesRequired()
      Description copied from class: AbstractCheck
      Whether comment nodes are required or not.
      Overrides:
      isCommentNodesRequired in class AbstractCheck
      Returns:
      false as a default value.
    • setStrategy

      public void setStrategy(String value)
      Setter to specify the policy on strategy of the block comment end position.
      Parameters:
      value - string to decode strategy from
      Throws:
      IllegalArgumentException - if unable to decode
      Since:
      14.4.0
    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process
    • isAlone

      private boolean isAlone(DetailAST ast)
      Checks whether the block comment end token is located alone on its own line.
      Parameters:
      ast - the block comment end token
      Returns:
      true if block comment end is alone