Class ModifierOrderCheck
- 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.modifier.ModifierOrderCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class ModifierOrderCheck extends AbstractCheck
Checks that the order of modifiers conforms to the suggestions in the Java Language specification, § 8.1.1, 8.3.1, 8.4.3 and 9.4. The correct order is:-
public
-
protected
-
private
-
abstract
-
default
-
static
-
sealed
-
non-sealed
-
final
-
transient
-
volatile
-
synchronized
-
native
-
strictfp
In additional, modifiers are checked to ensure all annotations are declared before all other modifiers.
Rationale: Code is easier to read if everybody follows a standard.
ATTENTION: We skip type annotations from validation.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
annotation.order
-
mod.order
- Since:
- 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 private static String[]
JLS_ORDER
The order of modifiers as suggested in sections 8.1.1, 8.3.1 and 8.4.3 of the JLS.static String
MSG_ANNOTATION_ORDER
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_MODIFIER_ORDER
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description ModifierOrderCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static DetailAST
checkOrderSuggestedByJls(List<DetailAST> modifiers)
Checks if the modifiers were added in the order suggested in the Java language specification.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.private static boolean
isAnnotationOnType(DetailAST modifier)
Checks whether annotation on type takes place.private static DetailAST
skipAnnotations(Iterator<DetailAST> modifierIterator)
Skip all annotations in modifier block.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
-
-
-
-
Field Detail
-
MSG_ANNOTATION_ORDER
public static final String MSG_ANNOTATION_ORDER
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_MODIFIER_ORDER
public static final String MSG_MODIFIER_ORDER
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ModifierOrderCheck
public ModifierOrderCheck()
-
-
Method Detail
-
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
-
checkOrderSuggestedByJls
private static DetailAST checkOrderSuggestedByJls(List<DetailAST> modifiers)
Checks if the modifiers were added in the order suggested in the Java language specification.- Parameters:
modifiers
- list of modifier AST tokens- Returns:
- null if the order is correct, otherwise returns the offending modifier AST.
-
skipAnnotations
private static DetailAST skipAnnotations(Iterator<DetailAST> modifierIterator)
Skip all annotations in modifier block.- Parameters:
modifierIterator
- iterator for collection of modifiers- Returns:
- modifier next to last annotation
-
isAnnotationOnType
private static boolean isAnnotationOnType(DetailAST modifier)
Checks whether annotation on type takes place.- Parameters:
modifier
- modifier token.- Returns:
- true if annotation on type takes place.
-
-