PlannedExerciseStep
class PlannedExerciseStep
| kotlin.Any | |
| ↳ | android.health.connect.datatypes.PlannedExerciseStep |
A single step within an PlannedExerciseBlock e.g. 8x 60kg barbell squats.
Summary
| Nested classes | |
|---|---|
|
Builder of |
|
| Constants | |
|---|---|
| static Int |
Active exercise. |
| static Int |
Cooldown exercise, typically at the end of a workout. |
| static Int |
Lower intensity, active exercise. |
| static Int |
A rest. |
| static Int |
An unknown category of exercise. |
| static Int |
A warmup. |
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| ExerciseCompletionGoal |
Returns the exercise completion goal for this step. |
| CharSequence? |
Returns the description of this step. |
| Int |
Returns the exercise category of this step. |
| Int |
Returns the exercise type of this step. |
| MutableList<ExercisePerformanceGoal!> |
Returns the exercise performance goals for this step. |
| Int |
hashCode()Returns a hash code value for the object. |
Constants
EXERCISE_CATEGORY_COOLDOWN
static val EXERCISE_CATEGORY_COOLDOWN: Int
Cooldown exercise, typically at the end of a workout.
Value: 4EXERCISE_CATEGORY_RECOVERY
static val EXERCISE_CATEGORY_RECOVERY: Int
Lower intensity, active exercise.
Value: 5EXERCISE_CATEGORY_UNKNOWN
static val EXERCISE_CATEGORY_UNKNOWN: Int
An unknown category of exercise.
Value: 0Public 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. |
getCompletionGoal
fun getCompletionGoal(): ExerciseCompletionGoal
Returns the exercise completion goal for this step.
| Return | |
|---|---|
ExerciseCompletionGoal |
This value cannot be null. |
getDescription
fun getDescription(): CharSequence?
Returns the description of this step.
| Return | |
|---|---|
CharSequence? |
This value may be null. |
getExerciseCategory
fun getExerciseCategory(): Int
Returns the exercise category of this step.
| Return | |
|---|---|
Int |
Value is one of the following: |
getExerciseType
fun getExerciseType(): Int
Returns the exercise type of this step.
getPerformanceGoals
fun getPerformanceGoals(): MutableList<ExercisePerformanceGoal!>
Returns the exercise performance goals for this step.
| Return | |
|---|---|
MutableList<ExercisePerformanceGoal!> |
An unmodifiable list of ExercisePerformanceGoal. This value cannot be null. |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |