qulice-checkstyle-0.1.9.src.main.java.com.qulice.checkstyle.EmptyLinesCheck Maven / Gradle / Ivy
/**
* Copyright (c) 2011-2012, Qulice.com
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met: 1) Redistributions of source code must retain the above
* copyright notice, this list of conditions and the following
* disclaimer. 2) Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution. 3) Neither the name of the Qulice.com nor
* the names of its contributors may be used to endorse or promote
* products derived from this software without specific prior written
* permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
* NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.qulice.checkstyle;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.regex.Pattern;
/**
* Check for empty lines inside methods and constructors.
*
* We believe that comments and empty lines are evil. If you need to use
* an empty line in order to add a vertical separator of concepts - refactor
* your code and make more cohesive and readable. The bottom line is that every
* method should look solid and do just one thing.
*
* @author Krzysztof Krason ([email protected])
* @author Yegor Bugayenko ([email protected])
* @version $Id: EmptyLinesCheck.java 445 2012-02-27 02:02:11Z guard $
*/
public final class EmptyLinesCheck extends Check {
/**
* Pattern for empty line check.
*/
private static final Pattern PATTERN = Pattern.compile("^\\s*$");
/**
* {@inheritDoc}
*/
@Override
public int[] getDefaultTokens() {
return new int[] {
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
};
}
/**
* {@inheritDoc}
*/
@Override
public void visitToken(final DetailAST ast) {
final DetailAST opening = ast.findFirstToken(TokenTypes.SLIST);
if (opening != null) {
final DetailAST closing =
opening.findFirstToken(TokenTypes.RCURLY);
final int firstLine = opening.getLineNo();
final int lastLine = closing.getLineNo();
final String[] lines = this.getLines();
for (int line = firstLine; line < lastLine; line += 1) {
if (this.PATTERN.matcher(lines[line]).find()) {
this.log(line + 1, "Empty line inside method");
}
}
}
}
}