Package ome.units.quantity
Class Frequency
java.lang.Object
ome.units.quantity.Quantity
ome.units.quantity.Frequency
- All Implemented Interfaces:
java.lang.Comparable<Frequency>
public class Frequency extends Quantity implements java.lang.Comparable<Frequency>
Frequency quantity.
- Since:
- 5.1
-
Constructor Summary
-
Method Summary
Modifier and Type Method Description int
compareTo(Frequency other)
Check quantities for equality.boolean
equals(java.lang.Object other)
Check quantities for equality.int
hashCode()
java.lang.String
toString()
Unit<Frequency>
unit()
Get the unit for this quantity.java.lang.Number
value()
Get the numerical value of this quantity.java.lang.Number
value(Unit<Frequency> inUnit)
Perform a unit conversion.
-
Constructor Details
-
Frequency
Create a Frequency.- Parameters:
inValue
- the value.inUnit
- the unit type.
-
-
Method Details
-
value
public java.lang.Number value()Description copied from class:Quantity
Get the numerical value of this quantity. -
value
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(java.lang.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 classjava.lang.Object
- Returns:
- true if equal, false if not equal.
-
compareTo
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 interfacejava.lang.Comparable<Frequency>
- Returns:
- true if equal, false if not equal.
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
unit
Description copied from class:Quantity
Get the unit for this quantity.
-