Package com.puppycrawl.tools.checkstyle.checks.whitespace

Class NoLineWrapCheck

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.whitespace.NoLineWrapCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class NoLineWrapCheck
extends AbstractCheck

Checks that chosen statements are not line-wrapped. By default, this Check restricts wrapping import and package statements, but it's possible to check any statement.

Since:

5.8

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_KEY	A key is pointing to the warning message text in "messages.properties" file.
private boolean	skipAnnotations	Property that defines whether annotations on the previous line should be checked as errors.

Constructor Summary

Constructors

Constructor	Description
NoLineWrapCheck()

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.
void	setSkipAnnotations(boolean shouldSkipAnnotations)	Setter to specify whether annotations on the previous line should be checked as errors.
private boolean	shouldReportViolation(boolean isOnSameLine, boolean containsAnnotation)	Determines whether a violation should be logged based on the AST node properties.
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, isCommentNodesRequired, 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_KEY

public static final String MSG_KEY

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

See Also:

• Constant Field Values

skipAnnotations

private boolean skipAnnotations

Property that defines whether annotations on the previous line should be checked as errors.

Constructor Details

NoLineWrapCheck

public NoLineWrapCheck()

Method Details

setSkipAnnotations

public void setSkipAnnotations(boolean shouldSkipAnnotations)

Setter to specify whether annotations on the previous line should be checked as errors.

Parameters:

shouldSkipAnnotations - whether to skip annotations on the previous line.

Since:

12.3.0

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

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

shouldReportViolation

private boolean shouldReportViolation(boolean isOnSameLine,
 boolean containsAnnotation)

Determines whether a violation should be logged based on the AST node properties.

Parameters:

isOnSameLine - indicates if the AST node and its last child on the same line

containsAnnotation - indicates if the AST node is annotated with annotation

Returns:

true if violation should be logged, false otherwise