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.indentation; 021 022import com.puppycrawl.tools.checkstyle.api.DetailAST; 023import com.puppycrawl.tools.checkstyle.api.TokenTypes; 024 025/** 026 * Handler for method definitions. 027 * 028 * @author jrichard 029 * @author Maikel Steneker 030 */ 031public class MethodDefHandler extends BlockParentHandler { 032 /** 033 * Construct an instance of this handler with the given indentation check, 034 * abstract syntax tree, and parent handler. 035 * 036 * @param indentCheck the indentation check 037 * @param ast the abstract syntax tree 038 * @param parent the parent handler 039 */ 040 public MethodDefHandler(IndentationCheck indentCheck, 041 DetailAST ast, AbstractExpressionHandler parent) { 042 super(indentCheck, getHandlerName(ast), ast, parent); 043 } 044 045 @Override 046 protected DetailAST getTopLevelAst() { 047 // we check this stuff ourselves below 048 return null; 049 } 050 051 @Override 052 protected void checkModifiers() { 053 final DetailAST modifier = getMainAst().findFirstToken(TokenTypes.MODIFIERS); 054 if (startsLine(modifier) 055 && !getLevel().isAcceptable(expandedTabsColumnNo(modifier))) { 056 logError(modifier, "modifier", expandedTabsColumnNo(modifier)); 057 } 058 } 059 060 @Override 061 public void checkIndentation() { 062 checkModifiers(); 063 064 final LineWrappingHandler lineWrap = 065 new LineWrappingHandler(getIndentCheck(), getMainAst(), 066 getMethodDefParamRightParen(getMainAst())); 067 lineWrap.checkIndentation(); 068 if (getLCurly() == null) { 069 // abstract method def -- no body 070 return; 071 } 072 super.checkIndentation(); 073 } 074 075 /** 076 * Returns right parenthesis of method definition parameter list. 077 * @param methodDefAst 078 * method definition ast node(TokenTypes.LITERAL_IF) 079 * @return right parenthesis of method definition parameter list. 080 */ 081 private static DetailAST getMethodDefParamRightParen(DetailAST methodDefAst) { 082 return methodDefAst.findFirstToken(TokenTypes.RPAREN); 083 } 084 085 /** 086 * Creates a handler name for this class according to ast type. 087 * 088 * @param ast the abstract syntax tree. 089 * @return handler name for this class. 090 */ 091 private static String getHandlerName(DetailAST ast) { 092 final String name; 093 094 if (ast.getType() == TokenTypes.CTOR_DEF) { 095 name = "ctor def"; 096 } 097 else { 098 name = "method def"; 099 } 100 return name; 101 } 102}