org.checkerframework.checker.units.qual.UnitsMultiple Maven / Gradle / Ivy

Go to download

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

checker-qual-android contains annotations (type qualifiers) that a programmer writes to specify Java code for type-checking by the Checker Framework. The checker-qual-android artifact is identical to the checker-qual artifact, except that in checker-qual-android annotations have classfile retention. The default Android Gradle plugin retains types annotated with runtime annotations in the main dex, but strips out class-retention annotations.

There is a newer version: 3.42.0-eisop5

Show newest version

package org.checkerframework.checker.units.qual;

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

/**
 * Define the relation between a base unit and the current unit.
 *
 * TODO: add support for factors and more general formulas? E.g. it would be cool if the relation
 * hour → minute and Fahrenheit → Celsius could be expressed.
 *
 * @checker_framework.manual #units-checker Units Checker
 */
@Documented
@Retention(RetentionPolicy.CLASS)
public @interface UnitsMultiple {
    /**
     * Returns the base unit to use.
     *
     * @return the base unit to use
     */
    Class quantity();

    /**
     * Returns the scaling prefix.
     *
     * @return the scaling prefix
     */
    Prefix prefix() default Prefix.one;
}