Package org.ka2ddo.util

Interface EnumWithUnits

All Known Implementing Classes:
HurricaneEnum, WeatherEnum
public interface EnumWithUnits
This interface is only for enumerations that specify another Enum as the unit for the value indexed by the first Enum.
Author:
Andrew Pavlin, KA2DDO

  • Method Summary

    Modifier and Type
    Method
    Description
    Enum<?>
    getUnit()
    Get the unit (if any) for values for this Enum,
    boolean
    isUnitARate()
    Indicate whether values and units should be interpreted as a rate over an appropriate time unit rather than a fixed quantity.

  • Method Details

    • getUnit

      Enum<?> getUnit()
      Get the unit (if any) for values for this Enum,
      Returns:
      unit Enum, or null if no unit known

    • isUnitARate

      boolean isUnitARate()
      Indicate whether values and units should be interpreted as a rate over an appropriate time unit rather than a fixed quantity.
      Returns:
      boolean true if unit is a rate rather than a scalar