org.codenarc.rule.exceptions.CommonCatchAstVisitor.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation

The CodeNarc project provides a static analysis tool for Groovy code.

There is a newer version: 3.5.0-groovy-4.0

/*
 * Copyright 2009 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.codenarc.rule.exceptions

import org.codehaus.groovy.ast.stmt.CatchStatement
import org.codenarc.rule.AbstractAstVisitor

/**
 * AstVisitor implementation that checks for catching an exception type specified in the constructor
 * 
 * This is an internal class and its API is subject to change.
 *
 * @author Chris Mair
  */
class CommonCatchAstVisitor extends AbstractAstVisitor  {

    private final exceptionClassNameWithoutPackage

    /**
     * Construct a new instance, specifying the exception class name
     * @param exceptionClassNameWithoutPackage - the name of the exception class to check for, without the package
     */
    CommonCatchAstVisitor(String exceptionClassNameWithoutPackage) {
        this.exceptionClassNameWithoutPackage = exceptionClassNameWithoutPackage
    }

    void visitCatchStatement(CatchStatement catchStatement) {
        if (isFirstVisit(catchStatement) && catchStatement.exceptionType.nameWithoutPackage == exceptionClassNameWithoutPackage) {
            addViolation(catchStatement, "The type $exceptionClassNameWithoutPackage should not be caught")
        }
        super.visitCatchStatement(catchStatement)
    }

}