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