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.coding;
021
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024import com.puppycrawl.tools.checkstyle.utils.CheckUtils;
025
026/**
027 * Restricts nested if-else blocks to a specified depth (default = 1).
028 *
029 * @author <a href="mailto:simon@redhillconsulting.com.au">Simon Harris</a>
030 */
031public final class NestedIfDepthCheck extends AbstractNestedDepthCheck {
032
033    /**
034     * A key is pointing to the warning message text in "messages.properties"
035     * file.
036     */
037    public static final String MSG_KEY = "nested.if.depth";
038
039    /** Default allowed nesting depth. */
040    private static final int DEFAULT_MAX = 1;
041
042    /** Creates new check instance with default allowed nesting depth. */
043    public NestedIfDepthCheck() {
044        super(DEFAULT_MAX);
045    }
046
047    @Override
048    public int[] getDefaultTokens() {
049        return new int[] {TokenTypes.LITERAL_IF};
050    }
051
052    @Override
053    public int[] getAcceptableTokens() {
054        return new int[] {TokenTypes.LITERAL_IF};
055    }
056
057    @Override
058    public void visitToken(DetailAST literalIf) {
059        if (!CheckUtils.isElseIf(literalIf)) {
060            nestIn(literalIf, MSG_KEY);
061        }
062    }
063
064    @Override
065    public void leaveToken(DetailAST literalIf) {
066        if (!CheckUtils.isElseIf(literalIf)) {
067            nestOut();
068        }
069    }
070
071}