edu.umd.cs.findbugs.InstructionScanner Maven / Gradle / Ivy

Go to download

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

SpotBugs: Because it's easy!

There is a newer version: 4.8.6

/*
 * FindBugs - Find bugs in Java programs
 * Copyright (C) 2003,2004 University of Maryland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.umd.cs.findbugs;

import org.apache.bcel.generic.InstructionHandle;

import edu.umd.cs.findbugs.ba.Edge;

/**
 * A scanner for implementing a state machine over a sequence of instructions
 * and control edges.
 */
public interface InstructionScanner {
    /**
     * Traverse an edge.
     */
    public void traverseEdge(Edge edge);

    /**
     * Traverse an instruction.
     */
    public void scanInstruction(InstructionHandle handle);

    /**
     * Return true if this scanner has completed, false otherwise.
     */
    public boolean isDone();
}