Class MissingOverrideCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public final class MissingOverrideCheck extends AbstractCheck
This class is used to verify that the
Override
annotation is present when the inheritDoc javadoc tag is present.Rationale: The
Override
annotation helps compiler tools ensure that an override is actually occurring. It is quite easy to accidentally overload a method or hide a static method and using theOverride
annotation points out these problems.This check will log a violation if using the inheritDoc tag on a method that is not valid (ex: private, or static method).
There is a slight difference between the Override annotation in Java 5 versus Java 6 and above. In Java 5, any method overridden from an interface cannot be annotated with Override. In Java 6 this behavior is allowed.
As a result of the aforementioned difference between Java 5 and Java 6, a property called
javaFiveCompatibility
is available. This property will only check classes, interfaces, etc. that do not contain the extends or implements keyword or are not anonymous classes. This means it only checks methods overridden fromjava.lang.Object
Java 5 Compatibility mode severely limits this check. It is recommended to only use it on Java 5 source<module name="MissingOverride"> <property name="javaFiveCompatibility" value="true"/> </module>
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
FQ_OVERRIDE
Fully-qualifiedOverride
annotation name.private boolean
javaFiveCompatibility
Java 5 compatibility option.private static java.util.regex.Pattern
MATCH_INHERIT_DOC
Compiled regexp to match Javadoc tags with no argument and {}.static java.lang.String
MSG_KEY_ANNOTATION_MISSING_OVERRIDE
A key is pointing to the warning message text in "messages.properties" file.static java.lang.String
MSG_KEY_TAG_NOT_VALID_ON
A key is pointing to the warning message text in "messages.properties" file.private static java.lang.String
OVERRIDE
Override
annotation name.
-
Constructor Summary
Constructors Constructor Description MissingOverrideCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static boolean
containsJavadocTag(TextBlock javadoc)
Checks to see if the text block contains a inheritDoc tag.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
setJavaFiveCompatibility(boolean compatibility)
Sets Java 5 compatibility mode.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_KEY_TAG_NOT_VALID_ON
public static final java.lang.String MSG_KEY_TAG_NOT_VALID_ON
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_KEY_ANNOTATION_MISSING_OVERRIDE
public static final java.lang.String MSG_KEY_ANNOTATION_MISSING_OVERRIDE
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
OVERRIDE
private static final java.lang.String OVERRIDE
Override
annotation name.- See Also:
- Constant Field Values
-
FQ_OVERRIDE
private static final java.lang.String FQ_OVERRIDE
Fully-qualifiedOverride
annotation name.- See Also:
- Constant Field Values
-
MATCH_INHERIT_DOC
private static final java.util.regex.Pattern MATCH_INHERIT_DOC
Compiled regexp to match Javadoc tags with no argument and {}.
-
javaFiveCompatibility
private boolean javaFiveCompatibility
Java 5 compatibility option.- See Also:
setJavaFiveCompatibility(boolean)
-
-
Method Detail
-
setJavaFiveCompatibility
public void setJavaFiveCompatibility(boolean compatibility)
Sets Java 5 compatibility mode.In Java 5, this check could flag code that is not valid for the Override annotation even though it is a proper override. See the class documentation for more information.
Set this to true to turn on Java 5 compatibility mode. Set this to false to turn off Java 5 compatibility mode.
- Parameters:
compatibility
- compatibility or not
-
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
-
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
-
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
-
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
-
containsJavadocTag
private static boolean containsJavadocTag(TextBlock javadoc)
Checks to see if the text block contains a inheritDoc tag.- Parameters:
javadoc
- the javadoc of the AST- Returns:
- true if contains the tag
-
-