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

Class JavadocTagContinuationIndentationCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocTagContinuationIndentationCheck
extends AbstractJavadocCheck

Checks the indentation of the continuation lines in at-clauses.

Default configuration:

 <module name="JavadocTagContinuationIndentation">
     <property name="offset" value="4"/>
 </module>
 

Field Summary

Fields

Modifier and Type	Field	Description
private static int	DEFAULT_INDENTATION	Default tag continuation indentation.
static java.lang.String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.
private int	offset	How many spaces to use for new indentation level.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

MSG_JAVADOC_MISSED_HTML_CLOSE, MSG_JAVADOC_PARSE_RULE_ERROR, MSG_JAVADOC_WRONG_SINGLETON_TAG, MSG_KEY_PARSE_ERROR, MSG_KEY_UNRECOGNIZED_ANTLR_ERROR

Constructor Summary

Constructors

Constructor	Description
JavadocTagContinuationIndentationCheck()

Method Summary

Modifier and Type	Method	Description
private static java.util.List<DetailNode>	getAllNewlineNodes(DetailNode descriptionNode)	Finds and collects all NEWLINE nodes inside DESCRIPTION node.
int[]	getDefaultJavadocTokens()	Returns the default javadoc token types a check is interested in.
int[]	getRequiredJavadocTokens()	The javadoc tokens that this check must be registered for.
private static boolean	isInlineDescription(DetailNode description)	Checks, if description node is a description of in-line tag.
void	setOffset(int offset)	Sets custom indentation level.
void	visitJavadocToken(DetailNode ast)	Called to process a Javadoc token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

beginJavadocTree, beginTree, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, visitToken

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

destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

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

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_KEY

public static final java.lang.String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

DEFAULT_INDENTATION

private static final int DEFAULT_INDENTATION

Default tag continuation indentation.

See Also:

Constant Field Values

offset

private int offset

How many spaces to use for new indentation level.

Constructor Detail

JavadocTagContinuationIndentationCheck

public JavadocTagContinuationIndentationCheck()

Method Detail

setOffset

public void setOffset(int offset)

Sets custom indentation level.

Parameters:

offset - custom value.

getDefaultJavadocTokens

public int[] getDefaultJavadocTokens()

Description copied from class: AbstractJavadocCheck

Returns the default javadoc token types a check is interested in.

Specified by:

getDefaultJavadocTokens in class AbstractJavadocCheck

Returns:

the default javadoc token types

See Also:

JavadocTokenTypes

getRequiredJavadocTokens

public int[] getRequiredJavadocTokens()

Description copied from class: AbstractJavadocCheck

The javadoc tokens that this check must be registered for.

Overrides:

getRequiredJavadocTokens in class AbstractJavadocCheck

Returns:

the javadoc token set this must be registered for.

See Also:

JavadocTokenTypes

visitJavadocToken

public void visitJavadocToken(DetailNode ast)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Specified by:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

ast - the token to process

getAllNewlineNodes

private static java.util.List<DetailNode> getAllNewlineNodes(DetailNode descriptionNode)

Finds and collects all NEWLINE nodes inside DESCRIPTION node.

Parameters:

descriptionNode - DESCRIPTION node.

Returns:

List with NEWLINE nodes.

isInlineDescription

private static boolean isInlineDescription(DetailNode description)

Checks, if description node is a description of in-line tag.

Parameters:

description - DESCRIPTION node.

Returns:

true, if description node is a description of in-line tag.