001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2018 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.StatelessCheck; 023import com.puppycrawl.tools.checkstyle.api.AbstractCheck; 024import com.puppycrawl.tools.checkstyle.api.DetailAST; 025import com.puppycrawl.tools.checkstyle.api.TokenTypes; 026 027/** 028 * Checks the style of array type definitions. 029 * Some like Java-style: {@code public static void main(String[] args)} 030 * and some like C-style: public static void main(String args[]) 031 * 032 * <p>By default the Check enforces Java style. 033 * @author lkuehne 034 */ 035@StatelessCheck 036public class ArrayTypeStyleCheck extends AbstractCheck { 037 038 /** 039 * A key is pointing to the warning message text in "messages.properties" 040 * file. 041 */ 042 public static final String MSG_KEY = "array.type.style"; 043 044 /** Controls whether to use Java or C style. */ 045 private boolean javaStyle = true; 046 047 @Override 048 public int[] getDefaultTokens() { 049 return getRequiredTokens(); 050 } 051 052 @Override 053 public int[] getAcceptableTokens() { 054 return getRequiredTokens(); 055 } 056 057 @Override 058 public int[] getRequiredTokens() { 059 return new int[] {TokenTypes.ARRAY_DECLARATOR}; 060 } 061 062 @Override 063 public void visitToken(DetailAST ast) { 064 final DetailAST typeAST = ast.getParent(); 065 if (typeAST.getType() == TokenTypes.TYPE 066 // Do not check method's return type. 067 // We have no alternatives here. 068 && typeAST.getParent().getType() != TokenTypes.METHOD_DEF) { 069 final DetailAST variableAST = typeAST.getNextSibling(); 070 if (variableAST != null) { 071 final boolean isJavaStyle = 072 variableAST.getLineNo() > ast.getLineNo() 073 || variableAST.getColumnNo() - ast.getColumnNo() > -1; 074 075 if (isJavaStyle != javaStyle) { 076 log(ast.getLineNo(), ast.getColumnNo(), MSG_KEY); 077 } 078 } 079 } 080 } 081 082 /** 083 * Controls whether to check for Java or C style. 084 * @param javaStyle true if Java style should be used. 085 */ 086 public void setJavaStyle(boolean javaStyle) { 087 this.javaStyle = javaStyle; 088 } 089 090}