Added in API level 34

Energy


public final class Energy
extends Object implements Comparable<Energy>

java.lang.Object
   ↳ android.health.connect.datatypes.units.Energy


Represents a unit of energy. Supported units: calories

Summary

Public methods

int compareTo(Energy other)

Compares this object with the specified object for order.

boolean equals(Object object)

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

static Energy fromCalories(double value)

Creates an Energy object with the specified value in calories.

double getInCalories()

Returns energy in calories

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public methods

compareTo

Added in API level 34
public int compareTo (Energy other)

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
other Energy: the object to be compared. This value cannot be null.

Returns
int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws
NullPointerException if the specified object is null
ClassCastException if the specified object's type prevents it from being compared to this object.

equals

Added in API level 34
public boolean equals (Object object)

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

Parameters
object Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the object argument; false otherwise.

fromCalories

Added in API level 34
public static Energy fromCalories (double value)

Creates an Energy object with the specified value in calories.

Parameters
value double: value to be set as calories.

Returns
Energy This value cannot be null.

getInCalories

Added in API level 34
public double getInCalories ()

Returns energy in calories

Returns
double

hashCode

Added in API level 34
public int hashCode ()

Returns a hash code value for the object.

Returns
int a hash code value for this object.

toString

Added in API level 34
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.