Enum Class VolumeUnit

java.lang.Object
java.lang.Enum<VolumeUnit>
com.irurueta.units.VolumeUnit
All Implemented Interfaces:
Serializable, Comparable<VolumeUnit>, Constable

public enum VolumeUnit extends Enum<VolumeUnit>
Enumerator containing recognized typical volume units.
  • Enum Constant Details

    • CUBIC_CENTIMETER

      public static final VolumeUnit CUBIC_CENTIMETER
      Cubic centimeter.
    • MILLILITER

      public static final VolumeUnit MILLILITER
      Milliliter.
    • CUBIC_DECIMETER

      public static final VolumeUnit CUBIC_DECIMETER
      Cubic decimeter.
    • LITER

      public static final VolumeUnit LITER
      Liter.
    • HECTOLITER

      public static final VolumeUnit HECTOLITER
      Hectoliter.
    • CUBIC_METER

      public static final VolumeUnit CUBIC_METER
      Cubic meter.
    • CUBIC_INCH

      public static final VolumeUnit CUBIC_INCH
      Cubic inch.
    • PINT

      public static final VolumeUnit PINT
      Pint.
    • GALLON

      public static final VolumeUnit GALLON
      Gallon.
    • CUBIC_FOOT

      public static final VolumeUnit CUBIC_FOOT
      Cubic foot.
    • BARREL

      public static final VolumeUnit BARREL
      Barrel.
  • Constructor Details

    • VolumeUnit

      private VolumeUnit()
  • Method Details

    • values

      public static VolumeUnit[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static VolumeUnit valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getUnitSystem

      public static UnitSystem getUnitSystem(VolumeUnit unit)
      Returns unit system from provided volume unit.
      Parameters:
      unit - volume unit to be checked.
      Returns:
      unit system (metric or imperial).
      Throws:
      IllegalArgumentException - if unit is null or not supported.
    • getMetricUnits

      public static VolumeUnit[] getMetricUnits()
      Gets all supported metric volume units.
      Returns:
      all supported metric volume units.
    • getImperialUnits

      public static VolumeUnit[] getImperialUnits()
      Gets all supported imperial volume units.
      Returns:
      all supported imperial volume units.
    • isMetric

      public static boolean isMetric(VolumeUnit unit)
      Indicates whether provided unit belongs to the metric unit system.
      Parameters:
      unit - volume unit to be checked.
      Returns:
      true if unit belongs to metric unit system.
      Throws:
      IllegalArgumentException - if unit is null or not supported.
    • isImperial

      public static boolean isImperial(VolumeUnit unit)
      Indicates whether provided unit belongs to the imperial unit system.
      Parameters:
      unit - volume unit to be checked.
      Returns:
      true if unit belongs to imperial unit system.
      Throws:
      IllegalArgumentException - if unit is null or not supported.