Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class BlockCommentEndPositionCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.BlockCommentEndPositionCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class BlockCommentEndPositionCheck
extends AbstractCheck

Checks that the Javadoc block comment end */ position is either alone on its own line or on the same line as the block comment begin code /**.

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:

13.3.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_BLOCK_COMMENT_END	A key is pointing to the warning message text in "messages.properties" file.
private BlockCommentEndPositionOption	strategy	Specify the strategy policy for the block comment end position.

Constructor Summary

Constructors

Constructor	Description
BlockCommentEndPositionCheck()

Method Summary

Modifier and Type	Method	Description
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
private boolean	isAlone(DetailAST ast)	Checks whether the block comment end token is located alone on its own line.
boolean	isCommentNodesRequired()	Whether comment nodes are required or not.
void	setStrategy(String value)	Setter to specify the policy on strategy of the block comment end position.
void	visitToken(DetailAST ast)	Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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:

• Constant Field Values

strategy

private BlockCommentEndPositionOption strategy

Specify the strategy policy for the block comment end position.

Constructor Details

BlockCommentEndPositionCheck

public BlockCommentEndPositionCheck()

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:

• 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

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

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:

13.3.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