TotalCaloriesBurnedGoal
class TotalCaloriesBurnedGoal : ExerciseCompletionGoal
| kotlin.Any | ||
| ↳ | android.health.connect.datatypes.ExerciseCompletionGoal | |
| ↳ | android.health.connect.datatypes.ExerciseCompletionGoal.TotalCaloriesBurnedGoal | |
An ExerciseCompletionGoal that requires a specified number of total calories to be burned.
Summary
| Public constructors | |
|---|---|
TotalCaloriesBurnedGoal(totalCalories: Energy) |
|
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Energy |
Returns the total calories that must be burned to complete this goal. |
| Int |
hashCode() |
Public constructors
TotalCaloriesBurnedGoal
TotalCaloriesBurnedGoal(totalCalories: Energy)
| Parameters | |
|---|---|
totalCalories |
Energy: The total calories that must be burnt to complete the goal. This value cannot be null. |
Public methods
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
o |
This value may be null. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getTotalCalories
fun getTotalCalories(): Energy
Returns the total calories that must be burned to complete this goal.
| Return | |
|---|---|
Energy |
This value cannot be null. |