org.walkmod.checkstyle.treewalkers.EmptyCatchBlock Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of walkmod-checkstyle-plugin Show documentation

Walkmod plugin to automatically fix the reported problems by Checkstyle

There is a newer version: 1.0.12

Show newest version

package org.walkmod.checkstyle.treewalkers;

import org.walkmod.checkstyle.visitors.AbstractCheckStyleRule;
import org.walkmod.javalang.ast.BlockComment;
import org.walkmod.javalang.ast.Comment;
import org.walkmod.javalang.ast.CompilationUnit;
import org.walkmod.javalang.ast.LineComment;
import org.walkmod.javalang.ast.stmt.BlockStmt;
import org.walkmod.javalang.ast.stmt.CatchClause;
import org.walkmod.javalang.ast.stmt.TryStmt;

import java.util.ArrayList;
import java.util.List;

public class EmptyCatchBlock extends AbstractCheckStyleRule {

    private String commentFormat = " Intentionally blank ";

    private List defaultCatchComments = new ArrayList();

    public String getCommentFormat() {
        return commentFormat;
    }

    public void setCommentFormat(String commentFormat) {
        this.commentFormat = commentFormat;
    }

    @Override
    public void visit(TryStmt n, A ctx) {
        List catchList = n.getCatchs();
        for (CatchClause catchClause : catchList) {
            if (catchClause.getCatchBlock().getStmts() == null) {
                addDefaultComment(catchClause.getCatchBlock());
            }
        }
        super.visit(n, ctx);
    }

    @Override
    public void visit(CompilationUnit cu, A ctx) {
        super.visit(cu, ctx);
        List cuComments = cu.getComments();
        if (!defaultCatchComments.isEmpty()) {
            if (cuComments != null && !cuComments.isEmpty()) {
                addOnlyNotOverlappedComments(cuComments);
            } else {
                cu.setComments(defaultCatchComments);
            }
        }
    }

    private void addOnlyNotOverlappedComments(List cuComments) {
        List commentsToAdd = new ArrayList();
        for (Comment catchComment : defaultCatchComments) {
            for (Comment cuComment : cuComments) {
                if (!areOverlappedComments(cuComment, catchComment)) {
                    commentsToAdd.add(catchComment);
                }
            }
        }
        cuComments.addAll(commentsToAdd);
    }

    private boolean areOverlappedComments(Comment cu1, Comment cu2) {
        return isCommentStartedInsideComment(cu1, cu2) || isCommentStartedInsideComment(cu2, cu1);
    }

    private boolean isCommentStartedInsideComment(Comment cu1, Comment cu2) {
        return (cu1.getBeginLine() > cu2.getBeginLine() || cu1.getBeginLine() == cu2.getBeginLine() && cu1.getBeginColumn() >= cu2.getBeginColumn())
                && (cu1.getBeginLine() < cu2.getEndLine() || cu1.getBeginLine() == cu2.getEndLine() && cu1.getEndColumn() <= cu2.getEndColumn());
    }

    private void addDefaultComment(BlockStmt catchBlock) {
        BlockComment blockComment = new BlockComment();
        blockComment.setContent(commentFormat);
        blockComment.setBeginLine(catchBlock.getBeginLine());
        blockComment.setEndLine(catchBlock.getEndLine());
        blockComment.setBeginColumn(catchBlock.getBeginColumn());
        blockComment.setEndColumn(catchBlock.getEndColumn());
        defaultCatchComments.add(blockComment);
    }
}

Related Artifacts