Added in API level 34

Energy

class Energy : Comparable<Energy!>
kotlin.Any
   ↳ android.health.connect.datatypes.units.Energy

Represents a unit of energy. Supported units: calories

Summary

Public methods
Int
compareTo(other: Energy)

Compares this object with the specified object for order.
Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
static Energy

Creates an Energy object with the specified value in calories.
Double

Returns energy in calories
Int

Returns a hash code value for the object.
String

Public methods

compareTo

Added in API level 34
fun compareTo(other: Energy): 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 Energy: 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

Added in API level 34
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.

fromCalories

Added in API level 34
static fun fromCalories(value: Double): Energy

Creates an Energy object with the specified value in calories.

Parameters
value Double: value to be set as calories.
Return
Energy This value cannot be null.

getInCalories

Added in API level 34
fun getInCalories(): Double

Returns energy in calories

hashCode

Added in API level 34
fun hashCode(): Int

Returns a hash code value for the object.

Return
Int a hash code value for this object.

toString

Added in API level 34
fun toString(): String
Return
String a string representation of the object.