org.checkerframework.dataflow.cfg.block.SingleSuccessorBlock Maven / Gradle / Ivy

Go to download

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

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

There is a newer version: 3.42.0-eisop4

Show newest version

package org.checkerframework.dataflow.cfg.block;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.checkerframework.dataflow.analysis.Store.FlowRule;
import org.checkerframework.dataflow.qual.Pure;

/** A basic block that has exactly one non-exceptional successor. */
public interface SingleSuccessorBlock extends Block {

    /**
     * Returns the non-exceptional successor block, or {@code null} if there is no non-exceptional
     * successor.
     *
     * @return the non-exceptional successor block, or {@code null} if there is no non-exceptional
     *     successor
     */
    @Pure
    @Nullable Block getSuccessor();

    /**
     * Returns the flow rule for information flowing from this block to its successor.
     *
     * @return the flow rule for information flowing from this block to its successor
     */
    @Pure
    FlowRule getFlowRule();

    /**
     * Set the flow rule for information flowing from this block to its successor.
     *
     * @param rule the new flow rule for information flowing from this block to its successor
     */
    void setFlowRule(FlowRule rule);
}