Length
class Length : Comparable<Length!>
Represents a unit of length. Supported units: meters
Summary
Public methods |
Int |
Compares this object with the specified object for order.
|
Boolean |
Indicates whether some other object is "equal to" this one.
|
static Length |
Creates a Length object with the specified value in meters.
|
Double |
Returns length in meters
|
Int |
Returns a hash code value for the object.
|
String |
|
Public methods
compareTo
fun compareTo(other: Length): Int
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Parameters |
o |
the object to be compared. |
other |
Length: the object to be compared. This value cannot be null . |
Return |
Int |
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. |
Exceptions |
java.lang.NullPointerException |
if the specified object is null |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
Parameters |
obj |
the reference object with which to compare. |
object |
the reference object with which to compare. |
Return |
Boolean |
true if this object is the same as the object argument; false otherwise. |
fromMeters
static fun fromMeters(value: Double): Length
Creates a Length object with the specified value in meters.
Parameters |
value |
Double: value to be set as meters. |
Return |
Length |
This value cannot be null . |
getInMeters
fun getInMeters(): Double
Returns length in meters
hashCode
fun hashCode(): Int
Returns a hash code value for the object.
Return |
Int |
a hash code value for this object. |
toString
fun toString(): String
Return |
String |
a string representation of the object. |