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

Public methods
Boolean
equals(other: Any?)

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

Energy

Returns the total calories that must be burned to complete this goal.

Int

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

Added in API level 35
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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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.

hashCode

Added in API level 35
fun hashCode(): Int
Return
Int a hash code value for this object.