////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2008 Oliver Burn
//
// 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.whitespace;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck;
/**
* <p>Checks the padding of an empty for initializer; that is whether a
* space is required at an empty for initializer, or such spaces are
* forbidden. No check occurs if there is a line wrap at the initializer, as in
* </p>
* <pre class="body">
for (
; i < j; i++, j--)
</pre>
* <p>
* The policy to verify is specified using the {@link PadOption} class and
* defaults to {@link PadOption#NOSPACE}.
* </p>
* <p>
* An example of how to configure the check is:
* </p>
* <pre>
* <module name="EmptyForInitializerPad"/>
* </pre>
*
* @author lkuehne
* @version 1.0
*/
public class EmptyForInitializerPadCheck
extends AbstractOptionCheck<PadOption>
{
/**
* Sets the paren pad otion to nospace.
*/
public EmptyForInitializerPadCheck()
{
super(PadOption.NOSPACE, PadOption.class);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.FOR_INIT,
};
}
@Override
public void visitToken(DetailAST aAST)
{
if (aAST.getChildCount() == 0) {
//empty for initializer. test pad before semi.
final DetailAST semi = (DetailAST) aAST.getNextSibling();
final int semiLineIdx = semi.getLineNo() - 1;
final String line = getLines()[semiLineIdx];
final int before = semi.getColumnNo() - 1;
//don't check if semi at beginning of line
if (!Utils.whitespaceBefore(before, line)) {
final PadOption option = getAbstractOption();
if ((PadOption.NOSPACE == option)
&& (Character.isWhitespace(line.charAt(before))))
{
log(semi.getLineNo(), before, "ws.preceded", ";");
}
else if ((PadOption.SPACE == option)
&& !Character.isWhitespace(line.charAt(before)))
{
log(semi.getLineNo(), before, "ws.notPreceded", ";");
}
}
}
}
}