org.checkerframework.common.value.qual.IntRangeFromNonNegative 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.common.value.qual;

import org.checkerframework.framework.qual.SubtypeOf;

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

/**
 * An expression with this type is exactly the same as an {@link IntRange} annotation whose {@code
 * from} field is {@code 0} and whose {@code to} field is {@code Integer.MAX_VALUE}. However, this
 * annotation is derived from an {@code org.checkerframework.checker.index.qual.NonNegative}
 * annotation.
 *
 * IntRangeFromNonNegative annotations derived from NonNegative annotations are used to create
 * IntRange annotations, but IntRangeFromNonNegative annotations are not checked when they appear on
 * the left hand side of expressions. Therefore, the Index Checker MUST be run on any code
 * with @NonNegative annotations on the left-hand side of expressions, since the Value Checker will
 * derive information from them but not check them.
 *
 * It is an error to write this annotation directly. {@code @NonNegative} or {@code IntRange(from
 * = 0, to = Integer.MAX_VALUE)} should always be written instead. This annotation is not retained
 * in bytecode, but is replaced with {@code @UnknownVal}, so that it is not enforced on method
 * boundaries. The {@code @NonNegative} annotation it replaced is retained in bytecode by the Lower
 * Bound Checker instead.
 *
 * @checker_framework.manual #constant-value-checker Constant Value Checker
 */
@Documented
@Retention(RetentionPolicy.SOURCE)
@Target({})
@SubtypeOf(UnknownVal.class)
public @interface IntRangeFromNonNegative {}