01: ////////////////////////////////////////////////////////////////////////////////
02: // checkstyle: Checks Java source code for adherence to a set of rules.
03: // Copyright (C) 2001-2007 Oliver Burn
04: //
05: // This library is free software; you can redistribute it and/or
06: // modify it under the terms of the GNU Lesser General Public
07: // License as published by the Free Software Foundation; either
08: // version 2.1 of the License, or (at your option) any later version.
09: //
10: // This library is distributed in the hope that it will be useful,
11: // but WITHOUT ANY WARRANTY; without even the implied warranty of
12: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: // Lesser General Public License for more details.
14: //
15: // You should have received a copy of the GNU Lesser General Public
16: // License along with this library; if not, write to the Free Software
17: // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18: ////////////////////////////////////////////////////////////////////////////////
19: package com.puppycrawl.tools.checkstyle.checks;
20:
21: import com.puppycrawl.tools.checkstyle.api.Check;
22: import com.puppycrawl.tools.checkstyle.api.TokenTypes;
23: import com.puppycrawl.tools.checkstyle.api.DetailAST;
24:
25: /**
26: * Checks the style of array type definitions.
27: * Some like Java-style: <code>public static void main(String[] args)</code>
28: * and some like C-style: public static void main(String args[])
29: *
30: * By default the Check enforces Java style.
31: * @author lkuehne
32: */
33: public class ArrayTypeStyleCheck extends Check {
34: /** controls whether to use Java or C style */
35: private boolean mJavaStyle = true;
36:
37: /** {@inheritDoc} */
38: public int[] getDefaultTokens() {
39: return new int[] { TokenTypes.ARRAY_DECLARATOR };
40: }
41:
42: /** {@inheritDoc} */
43: public void visitToken(DetailAST aAST) {
44: final DetailAST typeAST = aAST.getParent();
45: if (typeAST.getType() != TokenTypes.TYPE) {
46: return;
47: }
48: final DetailAST declAST = typeAST.getParent();
49: if (declAST.getType() == TokenTypes.METHOD_DEF) {
50: // Do not check method's return type.
51: // We have no alternatives here.
52: return;
53: }
54:
55: final DetailAST variableAST = (DetailAST) typeAST
56: .getNextSibling();
57: if (variableAST != null) {
58: final boolean isJavaStyle = (variableAST.getLineNo() > aAST
59: .getLineNo())
60: || (variableAST.getColumnNo() > aAST.getColumnNo());
61:
62: if (isJavaStyle != mJavaStyle) {
63: log(aAST.getLineNo(), aAST.getColumnNo(),
64: "array.type.style");
65: }
66: }
67: }
68:
69: /**
70: * Controls whether to check for Java or C style.
71: * @param aJavaStyle true if Java style should be used.
72: */
73: public void setJavaStyle(boolean aJavaStyle) {
74: mJavaStyle = aJavaStyle;
75: }
76: }
|