Class AbstractSuperCheck
- 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.AbstractSuperCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
- Direct Known Subclasses:
SuperCloneCheck
,SuperFinalizeCheck
public abstract class AbstractSuperCheck extends AbstractCheck
Abstract class for checking that an overriding method with no parameters invokes the super method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
AbstractSuperCheck.MethodNode
Stack node for a method definition and a record of whether the method has a call to the super method.-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private Deque<AbstractSuperCheck.MethodNode>
methodStack
Stack of methods.static String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description AbstractSuperCheck()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST rootAST)
Called before the starting to process a tree.int[]
getAcceptableTokens()
The configurable token set.int[]
getDefaultTokens()
Returns the default token a check is interested in.protected abstract String
getMethodName()
Returns the name of the overriding method.int[]
getRequiredTokens()
The tokens that this check must be registered for.private static boolean
hasArguments(DetailAST methodCallDotAst)
Does method have any arguments.private boolean
isOverridingMethod(DetailAST ast)
Determines whether an AST is a method definition for this check, without any parameters.private boolean
isSameNameMethod(DetailAST ast)
Is same name of method.private boolean
isSuperCall(DetailAST literalSuperAst)
Determines whether a 'super' literal is a call to the super method for this check.private boolean
isSuperCallInOverridingMethod(DetailAST ast)
Determines whether a super call in overriding method.void
leaveToken(DetailAST ast)
Called after all the child nodes have been process.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, 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
-
-
-
-
Field Detail
-
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
-
methodStack
private final Deque<AbstractSuperCheck.MethodNode> methodStack
Stack of methods.
-
-
Constructor Detail
-
AbstractSuperCheck
public AbstractSuperCheck()
-
-
Method Detail
-
getMethodName
protected abstract String getMethodName()
Returns the name of the overriding method.- Returns:
- the name of the overriding method.
-
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 classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
-
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 classAbstractCheck
- Returns:
- the default tokens
- 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 classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
beginTree
public void beginTree(DetailAST rootAST)
Description copied from class:AbstractCheck
Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.- Overrides:
beginTree
in classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
isSuperCall
private boolean isSuperCall(DetailAST literalSuperAst)
Determines whether a 'super' literal is a call to the super method for this check.- Parameters:
literalSuperAst
- the AST node of a 'super' literal.- Returns:
- true if ast is a call to the super method for this check.
-
isSuperCallInOverridingMethod
private boolean isSuperCallInOverridingMethod(DetailAST ast)
Determines whether a super call in overriding method.- Parameters:
ast
- The AST node of a 'dot operator' in 'super' call.- Returns:
- true if super call in overriding method.
-
hasArguments
private static boolean hasArguments(DetailAST methodCallDotAst)
Does method have any arguments.- Parameters:
methodCallDotAst
- DOT DetailAST- Returns:
- true if any parameters found
-
isSameNameMethod
private boolean isSameNameMethod(DetailAST ast)
Is same name of method.- Parameters:
ast
- method AST- Returns:
- true if method name is the same
-
leaveToken
public void leaveToken(DetailAST ast)
Description copied from class:AbstractCheck
Called after all the child nodes have been process.- Overrides:
leaveToken
in classAbstractCheck
- Parameters:
ast
- the token leaving
-
isOverridingMethod
private boolean isOverridingMethod(DetailAST ast)
Determines whether an AST is a method definition for this check, without any parameters.- Parameters:
ast
- the method definition AST.- Returns:
- true if the method of ast is a method for this check.
-
-