001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2015 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks;
021
022import com.puppycrawl.tools.checkstyle.api.Check;
023import com.puppycrawl.tools.checkstyle.api.DetailAST;
024import com.puppycrawl.tools.checkstyle.api.TokenTypes;
025
026/**
027 * Checks the style of array type definitions.
028 * Some like Java-style: {@code public static void main(String[] args)}
029 * and some like C-style: public static void main(String args[])
030 *
031 * <p>By default the Check enforces Java style.
032 * @author lkuehne
033 */
034public class ArrayTypeStyleCheck extends Check {
035    /** Controls whether to use Java or C style. */
036    private boolean javaStyle = true;
037
038    @Override
039    public int[] getDefaultTokens() {
040        return getAcceptableTokens();
041    }
042
043    @Override
044    public int[] getAcceptableTokens() {
045        return new int[] {TokenTypes.ARRAY_DECLARATOR};
046    }
047
048    @Override
049    public int[] getRequiredTokens() {
050        return getAcceptableTokens();
051    }
052
053    @Override
054    public void visitToken(DetailAST ast) {
055        final DetailAST typeAST = ast.getParent();
056        if (typeAST.getType() != TokenTypes.TYPE) {
057            return;
058        }
059        final DetailAST parentAst = typeAST.getParent();
060        if (parentAst.getType() == TokenTypes.METHOD_DEF) {
061            // Do not check method's return type.
062            // We have no alternatives here.
063            return;
064        }
065
066        final DetailAST variableAST = typeAST.getNextSibling();
067        if (variableAST != null) {
068            final boolean isJavaStyle =
069                variableAST.getLineNo() > ast.getLineNo()
070                || variableAST.getColumnNo() > ast.getColumnNo();
071
072            if (isJavaStyle != javaStyle) {
073                log(ast.getLineNo(), ast.getColumnNo(), "array.type.style");
074            }
075        }
076    }
077
078    /**
079     * Controls whether to check for Java or C style.
080     * @param javaStyle true if Java style should be used.
081     */
082    public void setJavaStyle(boolean javaStyle) {
083        this.javaStyle = javaStyle;
084    }
085}