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 standalone-sisu-uber Show documentation

There is a newer version: 3.0.0-alpha-3

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.RUNTIME)
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;
}