Class Frequency

java.lang.Object
ome.units.quantity.Quantity
ome.units.quantity.Frequency
All Implemented Interfaces:
Comparable<Frequency>

public class Frequency extends Quantity implements Comparable<Frequency>
Frequency quantity.
Since:
5.1
  • Constructor Details

    • Frequency

      public Frequency(Number inValue, Unit<Frequency> inUnit)
      Create a Frequency.
      Parameters:
      inValue - the value.
      inUnit - the unit type.
  • Method Details

    • value

      public Number value()
      Description copied from class: Quantity
      Get the numerical value of this quantity.
      Specified by:
      value in class Quantity
      Returns:
      the value.
    • value

      public Number value(Unit<Frequency> inUnit)
      Perform a unit conversion.
      Parameters:
      inUnit - the unit to convert to.
      Returns:
      the current quantity value converted to the specified unit, or null if the conversion is not possible.
    • equals

      public boolean equals(Object other)
      Check quantities for equality. Unit conversion will be performed when required to convert into the unit system of this quantity in order to perform the comparison. Note that floating point comparison is dangerous. Do not use this method.
      Overrides:
      equals in class Object
      Returns:
      true if equal, false if not equal.
    • compareTo

      public int compareTo(Frequency other)
      Check quantities for equality. Unit conversion will be performed when required to convert into the unit system of this quantity in order to perform the comparison. Note that floating point comparison is dangerous. Do not use this method.
      Specified by:
      compareTo in interface Comparable<Frequency>
      Returns:
      true if equal, false if not equal.
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • unit

      public Unit<Frequency> unit()
      Description copied from class: Quantity
      Get the unit for this quantity.
      Specified by:
      unit in class Quantity
      Returns:
      the unit.