org.checkerframework.checker.signedness.qual.Signed 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.44.0

Show newest version

package org.checkerframework.checker.signedness.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;
import org.checkerframework.framework.qual.DefaultFor;
import org.checkerframework.framework.qual.DefaultQualifierInHierarchy;
import org.checkerframework.framework.qual.SubtypeOf;
import org.checkerframework.framework.qual.TypeKind;
import org.checkerframework.framework.qual.TypeUseLocation;
import org.checkerframework.framework.qual.UpperBoundFor;

/**
 * The value is to be interpreted as signed. That is, if the most significant bit in the bitwise
 * representation is set, then the bits should be interpreted as a negative number.
 *
 * @checker_framework.manual #signedness-checker Signedness Checker
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})
@SubtypeOf({UnknownSignedness.class})
@DefaultFor(
    typeKinds = {
      TypeKind.BYTE,
      TypeKind.INT,
      TypeKind.LONG,
      TypeKind.SHORT,
      TypeKind.FLOAT,
      TypeKind.DOUBLE
    },
    types = {
      java.lang.Byte.class,
      java.lang.Integer.class,
      java.lang.Long.class,
      java.lang.Short.class,
      java.lang.Float.class,
      java.lang.Double.class
    },
    value = TypeUseLocation.EXCEPTION_PARAMETER)
@UpperBoundFor(
    typeKinds = {TypeKind.FLOAT, TypeKind.DOUBLE},
    types = {java.lang.Float.class, java.lang.Double.class})
@DefaultQualifierInHierarchy
public @interface Signed {}