Package com.irurueta.units

Enum Class DistanceUnit

java.lang.Object
java.lang.Enum<DistanceUnit>
com.irurueta.units.DistanceUnit
All Implemented Interfaces:
Serializable, Comparable<DistanceUnit>, Constable
public enum DistanceUnit extends Enum<DistanceUnit>
Enumerator containing recognized typical distance units.

  • Enum Constant Details

    • MILLIMETER

      public static final DistanceUnit MILLIMETER
      Millimeter distance unit.

    • CENTIMETER

      public static final DistanceUnit CENTIMETER
      Centimeter distance unit.

    • METER

      public static final DistanceUnit METER
      Meter distance unit.

    • KILOMETER

      public static final DistanceUnit KILOMETER
      Kilometer distance unit.

    • INCH

      public static final DistanceUnit INCH
      Inch distance unit.

    • YARD

      public static final DistanceUnit YARD
      Yard distance unit.

    • MILE

      public static final DistanceUnit MILE
      Mile distance unit.

  • Constructor Details

    • DistanceUnit

      private DistanceUnit()

  • Method Details

    • values

      public static DistanceUnit[] 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 DistanceUnit 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(DistanceUnit unit)
      Returns unit system for provided distance unit.
      Parameters:
      unit - distance unit to be checked.
      Returns:
      unit system (metric or imperial).
      Throws:
      IllegalArgumentException - if unit is null or not supported.

    • getMetricUnits

      public static DistanceUnit[] getMetricUnits()
      Gets all supported metric distance units.
      Returns:
      all supported metric distance units.

    • getImperialUnits

      public static DistanceUnit[] getImperialUnits()
      Gets all supported imperial distance units.
      Returns:
      all supported imperial distance units.

    • isMetric

      public static boolean isMetric(DistanceUnit unit)
      Indicates whether provided unit belongs to the metric unit system.
      Parameters:
      unit - distance 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(DistanceUnit unit)
      Indicates whether provided unit belongs to the imperial unit system.
      Parameters:
      unit - distance unit to be checked.
      Returns:
      true if unit belongs to imperial unit system.
      Throws:
      IllegalArgumentException - if unit is null or not supported.