dataflow.src.org.checkerframework.dataflow.qual.TerminatesExecution Maven / Gradle / Ivy

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

Show newest version

package org.checkerframework.dataflow.qual;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * {@code TerminatesExecution} is a method annotation that indicates that a
 * method terminates the execution of the program. This can be used to
 * annotate methods such as {@code System.exit()}.
 * 

 * The annotation enables flow-sensitive type refinement to be more
 * precise.  For example, after
 * 
 * if (x == null) {
 *   System.err.println("Bad value supplied");
 *   System.exit(1);
 * }
 * 
 * the Nullness Checker can determine that x is non-null.
 *
 * 
 * The annotation is a trusted annotation, meaning that it is not
 * checked whether the annotated method really does terminate the program.
 *
 * @checker_framework.manual #type-refinement Automatic type refinement (flow-sensitive type qualifier inference)
 *
 * @author Stefan Heule
 *
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.CONSTRUCTOR })
public @interface TerminatesExecution {
}