com.puppycrawl.tools.checkstyle.checks.whitespace

Class EmptyLineSeparatorCheck

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.whitespace.EmptyLineSeparatorCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class EmptyLineSeparatorCheck
extends Check

Checks for empty line separators after header, package, all import declarations, fields, constructors, methods, nested classes, static initializers and instance initializers.

By default the check will check the following statements: PACKAGE_DEF, IMPORT, CLASS_DEF, INTERFACE_DEF, STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF.

Example of declarations without empty line separator:

 ///////////////////////////////////////////////////
 //HEADER
 ///////////////////////////////////////////////////
 package com.puppycrawl.tools.checkstyle.whitespace;
 import java.io.Serializable;
 class Foo
 {
     public static final int FOO_CONST = 1;
     public void foo() {} //should be separated from previous statement.
 }
 

An example of how to configure the check with default parameters is:

 <module name="EmptyLineSeparator"/>
 

Example of declarations with empty line separator that is expected by the Check by default:

 ///////////////////////////////////////////////////
 //HEADER
 ///////////////////////////////////////////////////

 package com.puppycrawl.tools.checkstyle.whitespace;

 import java.io.Serializable;

 class Foo
 {
     public static final int FOO_CONST = 1;

     public void foo() {}
 }
 

An example how to check empty line after VARIABLE_DEF and METHOD_DEF:

 <module name="EmptyLineSeparator">
    <property name="tokens" value="VARIABLE_DEF, METHOD_DEF"/>
 </module>
 

An example how to allow no empty line between fields:

 <module name="EmptyLineSeparator">
    <property name="allowNoEmptyLineBetweenFields" value="true"/>
 </module>
 

Example of declarations with multiple empty lines between class members (allowed by default):

 ///////////////////////////////////////////////////
 //HEADER
 ///////////////////////////////////////////////////


 package com.puppycrawl.tools.checkstyle.whitespace;



 import java.io.Serializable;


 class Foo
 {
     public static final int FOO_CONST = 1;



     public void foo() {}
 }
 

An example how to disallow multiple empty lines between class members:

 <module name="EmptyLineSeparator">
    <property name="allowMultipleEmptyLines" value="false"/>
 </module>
 

Author:

maxvetrenko, Aleksey Nesterenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_MULTIPLE_LINES A key is pointing to the warning message empty.line.separator.multiple.lines in "messages.properties" file.
static String	MSG_SHOULD_BE_SEPARATED A key is pointing to the warning message empty.line.separator in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
EmptyLineSeparatorCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	setAllowMultipleEmptyLines(boolean allow) Allow multiple empty lines between class members.
void	setAllowNoEmptyLineBetweenFields(boolean allow) Allow no empty line between fields.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, 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

Methods inherited from class java.lang.Object

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

Field Detail

MSG_SHOULD_BE_SEPARATED

public static final String MSG_SHOULD_BE_SEPARATED

A key is pointing to the warning message empty.line.separator in "messages.properties" file.

See Also:

Constant Field Values

MSG_MULTIPLE_LINES

public static final String MSG_MULTIPLE_LINES

A key is pointing to the warning message empty.line.separator.multiple.lines in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

EmptyLineSeparatorCheck

public EmptyLineSeparatorCheck()

Method Detail

setAllowNoEmptyLineBetweenFields

public final void setAllowNoEmptyLineBetweenFields(boolean allow)

Allow no empty line between fields.

Parameters:

allow - User's value.

setAllowMultipleEmptyLines

public void setAllowMultipleEmptyLines(boolean allow)

Allow multiple empty lines between class members.

Parameters:

allow - User's value.

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

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