com.puppycrawl.tools.checkstyle.checks.coding

Class DeclarationOrderCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class DeclarationOrderCheck
extends Check

Checks that the parts of a class or interface declaration appear in the order suggested by the Code Conventions for the Java Programming Language.

1. Class (static) variables. First the public class variables, then the protected, then package level (no access modifier), and then the private.
2. Instance variables. First the public class variables, then the protected, then package level (no access modifier), and then the private.
3. Constructors
4. Methods

Available options:

• ignoreModifiers
• ignoreConstructors

Purpose of ignore* option is to ignore related violations, however it still impacts on other class members.

For example:

     class K {
         int a;
         void m(){}
         K(){}  <-- "Constructor definition in wrong order"
         int b; <-- "Instance variable definition in wrong order"
     }
 

With ignoreConstructors option:

     class K {
         int a;
         void m(){}
         K(){}
         int b; <-- "Instance variable definition in wrong order"
     }
 

With ignoreConstructors option and without a method definition in a source class:

     class K {
         int a;
         K(){}
         int b; <-- "Instance variable definition in wrong order"
     }
 

An example of how to configure the check is:

 <module name="DeclarationOrder"/>
 

Author:

r_auckenthaler

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_ACCESS A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_CONSTRUCTOR A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_INSTANCE A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_STATIC A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
DeclarationOrderCheck()

Method Summary

Modifier and Type	Method and Description
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	leaveToken(DetailAST ast) Called after all the child nodes have been process.
void	setIgnoreConstructors(boolean ignoreConstructors) Sets whether to ignore constructors.
void	setIgnoreModifiers(boolean ignoreModifiers) Sets whether to ignore modifiers.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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

Methods inherited from class java.lang.Object

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

Field Detail

MSG_CONSTRUCTOR

public static final String MSG_CONSTRUCTOR

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

See Also:

Constant Field Values

MSG_STATIC

public static final String MSG_STATIC

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

See Also:

Constant Field Values

MSG_INSTANCE

public static final String MSG_INSTANCE

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

See Also:

Constant Field Values

MSG_ACCESS

public static final String MSG_ACCESS

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

See Also:

Constant Field Values

Constructor Detail

DeclarationOrderCheck

public DeclarationOrderCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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 Check

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process

leaveToken

public void leaveToken(DetailAST ast)

Description copied from class: Check

Called after all the child nodes have been process.

Overrides:

leaveToken in class Check

Parameters:

ast - the token leaving

setIgnoreConstructors

public void setIgnoreConstructors(boolean ignoreConstructors)

Sets whether to ignore constructors.

Parameters:

ignoreConstructors - whether to ignore constructors.

setIgnoreModifiers

public void setIgnoreModifiers(boolean ignoreModifiers)

Sets whether to ignore modifiers.

Parameters:

ignoreModifiers - whether to ignore modifiers.