Package com.puppycrawl.tools.checkstyle.checks.modifier

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

Validates that the modifiers appear in the correct, standard order. By default 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 default order is:

1. public
2. protected
3. private
4. abstract
5. default
6. static
7. sealed
8. non-sealed
9. final
10. transient
11. volatile
12. synchronized
13. native
14. strictfp

Additionally, 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.

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 boolean	isCustomOrder	Indicates if the order of modifiers is custom.
private static final String[]	JLS_ORDER	The order of modifiers as suggested in sections 8.1.1, 8.3.1 and 8.4.3 of the JLS.
private String[]	modifiersOrder	To specify the order of modifiers.
static final String	MSG_ANNOTATION_ORDER	A key is pointing to the warning message text in "messages.properties" file.
static final String	MSG_MODIFIER_CUSTOM_ORDER	A key is pointing to the warning message text in "messages.properties" file.
static final String	MSG_MODIFIER_ORDER	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
ModifierOrderCheck()	Creates a new ModifierOrderCheck instance.

Method Summary

Modifier and Type	Method	Description
private 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.
void	setModifiersOrder(String... modifierOrder)	Setter to set the order of modifiers.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

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

MSG_MODIFIER_CUSTOM_ORDER

public static final String MSG_MODIFIER_CUSTOM_ORDER

A key is pointing to the warning message text in "messages.properties" file.

See Also:

• Constant Field Values

JLS_ORDER

private static final String[] JLS_ORDER

The order of modifiers as suggested in sections 8.1.1, 8.3.1 and 8.4.3 of the JLS.

modifiersOrder

private String[] modifiersOrder

To specify the order of modifiers.

isCustomOrder

private boolean isCustomOrder

Indicates if the order of modifiers is custom.

Constructor Details

ModifierOrderCheck

public ModifierOrderCheck()

Creates a new ModifierOrderCheck instance.

Method Details

setModifiersOrder

public void setModifiersOrder(String... modifierOrder)

Setter to set the order of modifiers.

Parameters:

modifierOrder - the order of modifiers

Since:

14.2.0

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

checkOrderSuggestedByJls

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