com.puppycrawl.tools.checkstyle.checks.indentation.ArrayInitHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation
Show all versions of checkstyle Show documentation
Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2016 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for array initialization blocks.
*
* @author jrichard
*/
public class ArrayInitHandler extends BlockParentHandler {
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param indentCheck the indentation check
* @param ast the abstract syntax tree
* @param parent the parent handler
*/
public ArrayInitHandler(IndentationCheck indentCheck,
DetailAST ast, AbstractExpressionHandler parent) {
super(indentCheck, "array initialization", ast, parent);
}
@Override
protected IndentLevel getIndentImpl() {
final DetailAST parentAST = getMainAst().getParent();
final int type = parentAST.getType();
if (type == TokenTypes.LITERAL_NEW || type == TokenTypes.ASSIGN) {
// note: assumes new or assignment is line to align with
return new IndentLevel(getLineStart(parentAST));
}
else {
// at this point getParent() is instance of BlockParentHandler
return ((BlockParentHandler) getParent()).getChildrenExpectedIndent();
}
}
@Override
protected DetailAST getTopLevelAst() {
return null;
}
@Override
protected DetailAST getLCurly() {
return getMainAst();
}
@Override
protected IndentLevel curlyIndent() {
final IndentLevel level = new IndentLevel(getIndent(), getBraceAdjustment());
level.addAcceptedIndent(level.getLastIndentLevel() + getLineWrappingIndentation());
return level;
}
@Override
protected DetailAST getRCurly() {
return getMainAst().findFirstToken(TokenTypes.RCURLY);
}
@Override
protected boolean shouldStartWithRCurly() {
return false;
}
@Override
protected boolean canChildrenBeNested() {
return true;
}
@Override
protected DetailAST getListChild() {
return getMainAst();
}
@Override
protected IndentLevel getChildrenExpectedIndent() {
final IndentLevel expectedIndent =
new IndentLevel(getIndent(), getIndentCheck().getArrayInitIndent(),
getIndentCheck().getLineWrappingIndentation());
final int firstLine = getFirstLine(Integer.MAX_VALUE, getListChild());
final int lcurlyPos = expandedTabsColumnNo(getLCurly());
final int firstChildPos =
getNextFirstNonBlankOnLineAfter(firstLine, lcurlyPos);
if (firstChildPos >= 0) {
expectedIndent.addAcceptedIndent(firstChildPos);
expectedIndent.addAcceptedIndent(lcurlyPos + getLineWrappingIndentation());
}
return expectedIndent;
}
/**
* @param lineNo number of line on which we search
* @param columnNo number of column after which we search
*
* @return column number of first non-blank char after
* specified column on specified line or -1 if
* such char doesn't exist.
*/
private int getNextFirstNonBlankOnLineAfter(int lineNo, int columnNo) {
int realColumnNo = columnNo + 1;
final String line = getIndentCheck().getLines()[lineNo - 1];
final int lineLength = line.length();
while (realColumnNo < lineLength
&& Character.isWhitespace(line.charAt(realColumnNo))) {
realColumnNo++;
}
if (realColumnNo == lineLength) {
return -1;
}
else {
return realColumnNo;
}
}
/**
* A shortcut for {@code IndentationCheck} property.
* @return value of lineWrappingIndentation property
* of {@code IndentationCheck}
*/
private int getLineWrappingIndentation() {
return getIndentCheck().getLineWrappingIndentation();
}
}