Class AbstractCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
- Direct Known Subclasses:
AbbreviationAsWordInNameCheck
,AbstractClassCouplingCheck
,AbstractClassNameCheck
,AbstractJavadocCheck
,AbstractNameCheck
,AbstractParenPadCheck
,AbstractSuperCheck
,AnnotationLocationCheck
,AnnotationOnSameLineCheck
,AnnotationUseStyleCheck
,AnonInnerLengthCheck
,ArrayTrailingCommaCheck
,ArrayTypeStyleCheck
,AvoidDoubleBraceInitializationCheck
,AvoidEscapedUnicodeCharactersCheck
,AvoidInlineConditionalsCheck
,AvoidNestedBlocksCheck
,AvoidNoArgumentSuperConstructorCallCheck
,AvoidStarImportCheck
,AvoidStaticImportCheck
,BooleanExpressionComplexityCheck
,ClassMemberImpliedModifierCheck
,CommentsIndentationCheck
,CovariantEqualsCheck
,CustomImportOrderCheck
,CyclomaticComplexityCheck
,DeclarationOrderCheck
,DefaultComesLastCheck
,DescendantTokenCheck
,DesignForExtensionCheck
,EmptyBlockCheck
,EmptyCatchBlockCheck
,EmptyForInitializerPadCheck
,EmptyForIteratorPadCheck
,EmptyLineSeparatorCheck
,EmptyStatementCheck
,EqualsAvoidNullCheck
,EqualsHashCodeCheck
,ExecutableStatementCountCheck
,ExplicitInitializationCheck
,FallThroughCheck
,FinalClassCheck
,FinalLocalVariableCheck
,FinalParametersCheck
,GenericWhitespaceCheck
,HiddenFieldCheck
,HideUtilityClassConstructorCheck
,IllegalCatchCheck
,IllegalImportCheck
,IllegalInstantiationCheck
,IllegalThrowsCheck
,IllegalTokenCheck
,IllegalTokenTextCheck
,IllegalTypeCheck
,ImportControlCheck
,ImportOrderCheck
,IndentationCheck
,InnerAssignmentCheck
,InnerTypeLastCheck
,InterfaceIsTypeCheck
,InterfaceMemberImpliedModifierCheck
,InvalidJavadocPositionCheck
,JavadocContentLocationCheck
,JavadocMethodCheck
,JavadocStyleCheck
,JavadocTypeCheck
,JavadocVariableCheck
,JavaNCSSCheck
,LeftCurlyCheck
,MagicNumberCheck
,MethodCountCheck
,MethodLengthCheck
,MethodParamPadCheck
,MissingCtorCheck
,MissingJavadocMethodCheck
,MissingJavadocPackageCheck
,MissingJavadocTypeCheck
,MissingOverrideCheck
,MissingSwitchDefaultCheck
,ModifiedControlVariableCheck
,ModifierOrderCheck
,MultipleStringLiteralsCheck
,MultipleVariableDeclarationsCheck
,MutableExceptionCheck
,NeedBracesCheck
,NestedForDepthCheck
,NestedIfDepthCheck
,NestedTryDepthCheck
,NoArrayTrailingCommaCheck
,NoCloneCheck
,NoCodeInFileCheck
,NoEnumTrailingCommaCheck
,NoFinalizerCheck
,NoLineWrapCheck
,NoWhitespaceAfterCheck
,NoWhitespaceBeforeCheck
,NPathComplexityCheck
,OneStatementPerLineCheck
,OneTopLevelClassCheck
,OperatorWrapCheck
,OuterTypeFilenameCheck
,OuterTypeNumberCheck
,OverloadMethodsDeclarationOrderCheck
,PackageAnnotationCheck
,PackageDeclarationCheck
,PackageNameCheck
,ParameterAssignmentCheck
,ParameterNumberCheck
,RecordComponentNumberCheck
,RedundantImportCheck
,RedundantModifierCheck
,RegexpCheck
,RegexpSinglelineJavaCheck
,RequireThisCheck
,ReturnCountCheck
,RightCurlyCheck
,SeparatorWrapCheck
,SimplifyBooleanExpressionCheck
,SimplifyBooleanReturnCheck
,SingleSpaceSeparatorCheck
,StringLiteralEqualityCheck
,SuppressWarningsCheck
,SuppressWarningsHolder
,ThrowsCountCheck
,TodoCommentCheck
,TrailingCommentCheck
,UncommentedMainCheck
,UnnecessaryParenthesesCheck
,UnnecessarySemicolonAfterOuterTypeDeclarationCheck
,UnnecessarySemicolonAfterTypeMemberDeclarationCheck
,UnnecessarySemicolonInEnumerationCheck
,UnnecessarySemicolonInTryWithResourcesCheck
,UnusedImportsCheck
,UpperEllCheck
,VariableDeclarationUsageDistanceCheck
,VisibilityModifierCheck
,WhitespaceAfterCheck
,WhitespaceAroundCheck
,WriteTagCheck
The base class for checks.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Called before the starting to process a tree.final void
Clears the sorted set ofLocalizedMessage
of the check.void
destroy()
Destroy the check.void
finishTree
(DetailAST rootAST) Called after finished processing a tree.abstract int[]
The configurable token set.abstract int[]
Returns the default token a check is interested in.final FileContents
Returns the file contents associated with the tree.final String
getLine
(int index) Returns the line associated with the tree.final String[]
getLines()
Returns the lines associated with the tree.Returns the sorted set ofLocalizedMessage
.abstract int[]
The tokens that this check must be registered for.protected final int
Get tab width to report audit events with.Returns the tokens registered for the check.void
init()
Initialize the check.boolean
Whether comment nodes are required or not.void
leaveToken
(DetailAST ast) Called after all the child nodes have been process.final void
Log a message that has column information.final void
Log a message that has no column information.final void
Helper method to log a LocalizedMessage.final void
setFileContents
(FileContents contents) Set the file contents associated with the tree.final void
setTabWidth
(int tabWidth) Set the tab width to report audit events with.final void
Adds a set of tokens the check is interested in.void
visitToken
(DetailAST ast) Called to process a token.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.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Constructor Details
-
AbstractCheck
public AbstractCheck()
-
-
Method Details
-
getDefaultTokens
public abstract int[] getDefaultTokens()Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Returns:
- the default tokens
- See Also:
-
getAcceptableTokens
public abstract int[] getAcceptableTokens()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.- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
public abstract int[] getRequiredTokens()The tokens that this check must be registered for.- Returns:
- the token set this must be registered for.
- See Also:
-
isCommentNodesRequired
public boolean isCommentNodesRequired()Whether comment nodes are required or not.- Returns:
- false as a default value.
-
setTokens
Adds a set of tokens the check is interested in.- Parameters:
strRep
- the string representation of the tokens interested in
-
getTokenNames
Returns the tokens registered for the check.- Returns:
- the set of token names
-
getMessages
Returns the sorted set ofLocalizedMessage
.- Returns:
- the sorted set of
LocalizedMessage
.
-
clearMessages
public final void clearMessages()Clears the sorted set ofLocalizedMessage
of the check. -
init
public void init()Initialize the check. This is the time to verify that the check has everything required to perform it job. -
destroy
public void destroy()Destroy the check. It is being retired from service. -
beginTree
Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.- Parameters:
rootAST
- the root of the tree
-
finishTree
Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.- Parameters:
rootAST
- the root of the tree
-
visitToken
Called to process a token.- Parameters:
ast
- the token to process
-
leaveToken
Called after all the child nodes have been process.- Parameters:
ast
- the token leaving
-
setFileContents
Set the file contents associated with the tree.- Parameters:
contents
- the manager
-
getFileContents
Returns the file contents associated with the tree.- Returns:
- the file contents
-
getTabWidth
protected final int getTabWidth()Get tab width to report audit events with.- Returns:
- the tab width to audit events with
-
setTabWidth
public final void setTabWidth(int tabWidth) Set the tab width to report audit events with.- Parameters:
tabWidth
- anint
value
-
log
Description copied from class:AbstractViolationReporter
Log a message that has no column information.- Specified by:
log
in classAbstractViolationReporter
- Parameters:
line
- the line number where the audit event was foundkey
- the message that describes the audit eventargs
- the details of the message- See Also:
-
log
Description copied from class:AbstractViolationReporter
Log a message that has column information.- Specified by:
log
in classAbstractViolationReporter
- Parameters:
lineNo
- the line number where the audit event was foundcolNo
- the column number where the audit event was foundkey
- the message that describes the audit eventargs
- the details of the message- See Also:
-
log
Helper method to log a LocalizedMessage.- Parameters:
ast
- a node to get line id column numbers associated with the messagekey
- key to locale message formatargs
- arguments to format
-
getLines
Returns the lines associated with the tree.- Returns:
- the file contents
-
getLine
Returns the line associated with the tree.- Parameters:
index
- index of the line- Returns:
- the line from the file contents
-