001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2014 Oliver Burn 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//////////////////////////////////////////////////////////////////////////////// 019package com.puppycrawl.tools.checkstyle.checks.sizes; 020 021import com.puppycrawl.tools.checkstyle.api.DetailAST; 022import com.puppycrawl.tools.checkstyle.api.TokenTypes; 023import com.puppycrawl.tools.checkstyle.api.Check; 024 025/** 026 * Checks for the number of defined types at the "outer" level. 027 * @author oliverb 028 */ 029public class OuterTypeNumberCheck extends Check 030{ 031 /** The maximum allowed number of outer types. */ 032 private int max = 1; 033 /** Tracks the current depth in types. */ 034 private int currentDepth; 035 /** Tracks the number of outer types found. */ 036 private int outerNum; 037 038 @Override 039 public int[] getDefaultTokens() 040 { 041 return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF, 042 TokenTypes.ENUM_DEF, TokenTypes.ANNOTATION_DEF, }; 043 } 044 045 @Override 046 public void beginTree(DetailAST ast) 047 { 048 currentDepth = 0; 049 outerNum = 0; 050 } 051 052 @Override 053 public void finishTree(DetailAST ast) 054 { 055 if (max < outerNum) { 056 log(ast, "maxOuterTypes", outerNum, max); 057 } 058 } 059 060 @Override 061 public void visitToken(DetailAST ast) 062 { 063 if (0 == currentDepth) { 064 outerNum++; 065 } 066 currentDepth++; 067 } 068 069 @Override 070 public void leaveToken(DetailAST ast) 071 { 072 currentDepth--; 073 } 074 075 /** 076 * Sets the maximum allowed number of outer types. 077 * @param to the new number. 078 */ 079 public void setMax(int to) 080 { 081 max = to; 082 } 083}