PlannedExerciseStep


public final class PlannedExerciseStep
extends Object

java.lang.Object
   ↳ android.health.connect.datatypes.PlannedExerciseStep


A single step within an PlannedExerciseBlock e.g. 8x 60kg barbell squats.

Summary

Nested classes

class PlannedExerciseStep.Builder

Builder of PlannedExerciseStep

Constants

int EXERCISE_CATEGORY_ACTIVE

Active exercise.

int EXERCISE_CATEGORY_COOLDOWN

Cooldown exercise, typically at the end of a workout.

int EXERCISE_CATEGORY_RECOVERY

Lower intensity, active exercise.

int EXERCISE_CATEGORY_REST

A rest.

int EXERCISE_CATEGORY_UNKNOWN

An unknown category of exercise.

int EXERCISE_CATEGORY_WARMUP

A warmup.

Public methods

boolean equals(Object o)

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

ExerciseCompletionGoal getCompletionGoal()

Returns the exercise completion goal for this step.

CharSequence getDescription()

Returns the description of this step.

int getExerciseCategory()

Returns the exercise category of this step.

int getExerciseType()

Returns the exercise type of this step.

List<ExercisePerformanceGoal> getPerformanceGoals()

Returns the exercise performance goals for this step.

int hashCode()

Returns a hash code value for the object.

Inherited methods

Constants

EXERCISE_CATEGORY_ACTIVE

Added in API level 35
Also in U Extensions 13
public static final int EXERCISE_CATEGORY_ACTIVE

Active exercise.

Constant Value: 3 (0x00000003)

EXERCISE_CATEGORY_COOLDOWN

Added in API level 35
Also in U Extensions 13
public static final int EXERCISE_CATEGORY_COOLDOWN

Cooldown exercise, typically at the end of a workout.

Constant Value: 4 (0x00000004)

EXERCISE_CATEGORY_RECOVERY

Added in API level 35
Also in U Extensions 13
public static final int EXERCISE_CATEGORY_RECOVERY

Lower intensity, active exercise.

Constant Value: 5 (0x00000005)

EXERCISE_CATEGORY_REST

Added in API level 35
Also in U Extensions 13
public static final int EXERCISE_CATEGORY_REST

A rest.

Constant Value: 2 (0x00000002)

EXERCISE_CATEGORY_UNKNOWN

Added in API level 35
Also in U Extensions 13
public static final int EXERCISE_CATEGORY_UNKNOWN

An unknown category of exercise.

Constant Value: 0 (0x00000000)

EXERCISE_CATEGORY_WARMUP

Added in API level 35
Also in U Extensions 13
public static final int EXERCISE_CATEGORY_WARMUP

A warmup.

Constant Value: 1 (0x00000001)

Public methods

equals

Added in API level 35
public boolean equals (Object o)

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
o Object: This value may be null.

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

getCompletionGoal

Added in API level 35
Also in U Extensions 13
public ExerciseCompletionGoal getCompletionGoal ()

Returns the exercise completion goal for this step.

Returns
ExerciseCompletionGoal This value cannot be null.

getDescription

Added in API level 35
Also in U Extensions 13
public CharSequence getDescription ()

Returns the description of this step.

Returns
CharSequence This value may be null.

getExerciseCategory

Added in API level 35
Also in U Extensions 13
public int getExerciseCategory ()

Returns the exercise category of this step.

Returns
int Value is EXERCISE_CATEGORY_UNKNOWN, EXERCISE_CATEGORY_WARMUP, EXERCISE_CATEGORY_REST, EXERCISE_CATEGORY_ACTIVE, EXERCISE_CATEGORY_COOLDOWN, or EXERCISE_CATEGORY_RECOVERY

getExerciseType

Added in API level 35
Also in U Extensions 13
public int getExerciseType ()

Returns the exercise type of this step.

Returns
int Value is ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_UNKNOWN, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_BARBELL_SHOULDER_PRESS, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_BENCH_SIT_UP, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_BIKING, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_BIKING_STATIONARY, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DUMBBELL_CURL_LEFT_ARM, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DUMBBELL_CURL_RIGHT_ARM, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DUMBBELL_FRONT_RAISE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DUMBBELL_LATERAL_RAISE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DUMBBELL_TRICEPS_EXTENSION_LEFT_ARM, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DUMBBELL_TRICEPS_EXTENSION_RIGHT_ARM, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DUMBBELL_TRICEPS_EXTENSION_TWO_ARM, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_FORWARD_TWIST, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_ELLIPTICAL, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_HIGH_INTENSITY_INTERVAL_TRAINING, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_PILATES, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_ROWING_MACHINE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_RUNNING, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_RUNNING_TREADMILL, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_STAIR_CLIMBING, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_STAIR_CLIMBING_MACHINE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_STRETCHING, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SWIMMING_OPEN_WATER, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SWIMMING_POOL, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_UPPER_TWIST, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_WALKING, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_WEIGHTLIFTING, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_WHEELCHAIR, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_OTHER_WORKOUT, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_YOGA, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_ARM_CURL, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_BACK_EXTENSION, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_BALL_SLAM, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_BENCH_PRESS, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_BURPEE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_CRUNCH, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DEADLIFT, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DOUBLE_ARM_TRICEPS_EXTENSION, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_DUMBBELL_ROW, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_FRONT_RAISE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_HIP_THRUST, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_HULA_HOOP, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_JUMPING_JACK, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_JUMP_ROPE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_KETTLEBELL_SWING, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_LATERAL_RAISE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_LAT_PULL_DOWN, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_LEG_CURL, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_LEG_EXTENSION, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_LEG_PRESS, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_LEG_RAISE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_LUNGE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_MOUNTAIN_CLIMBER, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_PLANK, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_PULL_UP, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_PUNCH, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SHOULDER_PRESS, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SINGLE_ARM_TRICEPS_EXTENSION, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SIT_UP, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SQUAT, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SWIMMING_FREESTYLE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SWIMMING_BACKSTROKE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SWIMMING_BREASTSTROKE, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SWIMMING_BUTTERFLY, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SWIMMING_MIXED, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_SWIMMING_OTHER, ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_REST, or ExerciseSegmentType.EXERCISE_SEGMENT_TYPE_PAUSE

getPerformanceGoals

Added in API level 35
Also in U Extensions 13
public List<ExercisePerformanceGoal> getPerformanceGoals ()

Returns the exercise performance goals for this step.

Returns
List<ExercisePerformanceGoal> An unmodifiable list of ExercisePerformanceGoal. This value cannot be null.

hashCode

Added in API level 35
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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.

Returns
int a hash code value for this object.