Package com.puppycrawl.tools.checkstyle.checks

Class HexLiteralCaseCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class HexLiteralCaseCheck
extends AbstractCheck

Checks that hexadecimal literals are defined using uppercase letters (A-F) rather than lowercase (a-f). This convention follows the OpenJDK Style Guide.

Since:

12.1.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
private static final int	A_LOWER_ASCII	ASCII value for lowercase 'a'.
private static final int	F_LOWER_ASCII	ASCII value for lowercase 'f'.
static final String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
HexLiteralCaseCheck()

Method Summary

Modifier and Type	Method	Description
private static boolean	containsLowerLetter(String text)	Checks if the given text contains any lowercase hexadecimal letter (a–f).
static boolean	containsLowerLetterInHexFloatLiteral(String text)	Checks if the given text contains any lowercase hexadecimal letter in Hex Float Literal (a–f).
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	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

A_LOWER_ASCII

private static final int A_LOWER_ASCII

ASCII value for lowercase 'a'.

See Also:

• Constant Field Values

F_LOWER_ASCII

private static final int F_LOWER_ASCII

ASCII value for lowercase 'f'.

See Also:

• Constant Field Values

Constructor Details

HexLiteralCaseCheck

public HexLiteralCaseCheck()

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

containsLowerLetter

private static boolean containsLowerLetter(String text)

Checks if the given text contains any lowercase hexadecimal letter (a–f).

Parameters:

text - the literal text to check

Returns:

true if the literal contains lowercase hex digits; false otherwise

containsLowerLetterInHexFloatLiteral

public static boolean containsLowerLetterInHexFloatLiteral(String text)

Checks if the given text contains any lowercase hexadecimal letter in Hex Float Literal (a–f).

Parameters:

text - the literal text to check

Returns:

true if the literal contains lowercase hex digits; false otherwise