Package com.puppycrawl.tools.checkstyle.checks.coding

Class TextBlockGoogleStyleFormattingCheck

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.coding.TextBlockGoogleStyleFormattingCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class TextBlockGoogleStyleFormattingCheck
extends AbstractCheck

Checks correct format of Java Text Blocks as specified in Google Java Style Guide.

This Check performs two validations:

1. It ensures that the opening and closing text-block quotes (""") each appear on their own line, with no other item preceding them.
2. Opening and closing quotes are vertically aligned.

Note: Closing quotes can be followed by additional code on the same line.

Since:

12.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_CLOSE_QUOTES_ERROR	A key is pointing to the warning message text in "messages.properties" file.
static final String	MSG_OPEN_QUOTES_ERROR	A key is pointing to the warning message text in "messages.properties" file.
static final String	MSG_VERTICALLY_UNALIGNED	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
TextBlockGoogleStyleFormattingCheck()

Method Summary

Modifier and Type	Method	Description
private static boolean	closingQuotesAreAloneOnTheLine(DetailAST closingQuotes)	Determines if the Closing quotes of text block are not preceded by any code.
int[]	getAcceptableTokens()	The configurable token set.
private static DetailAST	getClosingQuotes(DetailAST ast)	Gets the TEXT_BLOCK_LITERAL_END of a TEXT_BLOCK_LITERAL_BEGIN.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
private static boolean	openingQuotesAreAloneOnTheLine(DetailAST openingQuotes)	Determines if the Opening quotes of text block are not preceded by any code.
private static boolean	quotesArePrecededWithComma(DetailAST openingQuotes)	Determines if opening quotes are preceded by ,.
private static boolean	quotesAreVerticallyAligned(DetailAST openQuotes, DetailAST closeQuotes)	Checks if opening and closing quotes are vertically aligned.
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_OPEN_QUOTES_ERROR

public static final String MSG_OPEN_QUOTES_ERROR

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

See Also:

• Constant Field Values

MSG_CLOSE_QUOTES_ERROR

public static final String MSG_CLOSE_QUOTES_ERROR

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

See Also:

• Constant Field Values

MSG_VERTICALLY_UNALIGNED

public static final String MSG_VERTICALLY_UNALIGNED

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

See Also:

• Constant Field Values

Constructor Details

TextBlockGoogleStyleFormattingCheck

public TextBlockGoogleStyleFormattingCheck()

Method Details

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

quotesAreVerticallyAligned

private static boolean quotesAreVerticallyAligned(DetailAST openQuotes,
 DetailAST closeQuotes)

Checks if opening and closing quotes are vertically aligned.

Parameters:

openQuotes - the ast to check.

closeQuotes - the ast to check.

Returns:

true if both quotes have same indentation else false.

getClosingQuotes

private static DetailAST getClosingQuotes(DetailAST ast)

Gets the TEXT_BLOCK_LITERAL_END of a TEXT_BLOCK_LITERAL_BEGIN.

Parameters:

ast - the ast to check

Returns:

DetailAST TEXT_BLOCK_LITERAL_END

openingQuotesAreAloneOnTheLine

private static boolean openingQuotesAreAloneOnTheLine(DetailAST openingQuotes)

Determines if the Opening quotes of text block are not preceded by any code.

Parameters:

openingQuotes - opening quotes

Returns:

true if the opening quotes are on the new line.

quotesArePrecededWithComma

private static boolean quotesArePrecededWithComma(DetailAST openingQuotes)

Determines if opening quotes are preceded by ,.

Parameters:

openingQuotes - the quotes

Returns:

true if , is present before opening quotes.

closingQuotesAreAloneOnTheLine

private static boolean closingQuotesAreAloneOnTheLine(DetailAST closingQuotes)

Determines if the Closing quotes of text block are not preceded by any code.

Parameters:

closingQuotes - closing quotes

Returns:

true if the closing quotes are on the new line.