Percentage
class Percentage : Comparable<Percentage!>
kotlin.Any | |
↳ | android.health.connect.datatypes.units.Percentage |
Represents a value as a percentage, not a fraction - for example 100%, 89.62%, etc.
Summary
Public methods | |
---|---|
Int |
compareTo(other: Percentage) Compares this object with the specified object for order. |
Boolean |
Indicates whether some other object is "equal to" this one. |
static Percentage |
Creates a Percentage object with the specified value |
Double |
getValue() Returns the percentage. |
Int |
hashCode() Returns a hash code value for the object. |
String |
toString() |
Public methods
compareTo
fun compareTo(other: Percentage): 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 |
Percentage: 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. |
fromValue
static fun fromValue(value: Double): Percentage
Creates a Percentage object with the specified value
Parameters | |
---|---|
value |
Double: value to be set as percentage. The value must be between 0 and 100. |
Return | |
---|---|
Percentage |
This value cannot be null . |
getValue
fun getValue(): Double
Returns the percentage. The value is between 0 and 100.
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. |