Stay organized with collections
Save and categorize content based on your preferences.
DistanceWithVariableRestGoal
class DistanceWithVariableRestGoal : ExerciseCompletionGoal
An ExerciseCompletionGoal that requires covering a specified distance. Additionally, the step is not complete until the specified time has elapsed. Time remaining after the specified distance has been completed should be spent resting. In the context of swimming, this is sometimes referred to as 'interval training'.
For example, a swimming coach may specify '100m @ 1min40s'. This implies: complete 100m and if you manage it in 1min30s, you will have 10s of rest prior to the next set.
Summary
| Public methods |
| Boolean |
Indicates whether some other object is "equal to" this one.
|
| Length |
Returns the total distance that must be covered to complete this goal.
|
| Duration |
Returns the total duration that must elapse to complete this goal.
|
| Int |
|
Public constructors
DistanceWithVariableRestGoal
DistanceWithVariableRestGoal(
distance: Length,
duration: Duration)
| Parameters |
distance |
Length: The total distance that must be covered to complete the goal. This value cannot be null. |
duration |
Duration: The total duration that must elapse 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 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. |
getDistance
fun getDistance(): Length
Returns the total distance that must be covered to complete this goal.
| Return |
Length |
This value cannot be null. |
getDuration
fun getDuration(): Duration
Returns the total duration that must elapse to complete this goal.
| Return |
Duration |
This value cannot be null. |
hashCode
fun hashCode(): Int
| Return |
Int |
a hash code value for this object. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# ExerciseCompletionGoal.DistanceWithVariableRestGoal\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nAlso in [U Extensions 13](https://developer.android.com/sdkExtensions)\n\nDistanceWithVariableRestGoal\n============================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/health/connect/datatypes/ExerciseCompletionGoal.DistanceWithVariableRestGoal \"View this page in Java\") \n\n```\nclass DistanceWithVariableRestGoal : ExerciseCompletionGoal\n```\n\n|---|---|-------------------------------------------------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||\n| ↳ | [android.health.connect.datatypes.ExerciseCompletionGoal](/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal) ||\n| | ↳ | [android.health.connect.datatypes.ExerciseCompletionGoal.DistanceWithVariableRestGoal](#) |\n\nAn [ExerciseCompletionGoal](/reference/kotlin/android/health/connect/datatypes/ExerciseCompletionGoal) that requires covering a specified distance. Additionally, the step is not complete until the specified time has elapsed. Time remaining after the specified distance has been completed should be spent resting. In the context of swimming, this is sometimes referred to as 'interval training'.\n\nFor example, a swimming coach may specify '100m @ 1min40s'. This implies: complete 100m and if you manage it in 1min30s, you will have 10s of rest prior to the next set.\n\nSummary\n-------\n\n| Public constructors ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [DistanceWithVariableRestGoal](#DistanceWithVariableRestGoal(android.health.connect.datatypes.units.Length,%20java.time.Duration))`(`distance:` `[Length](/reference/kotlin/android/health/connect/datatypes/units/Length)`, `duration:` `[Duration](../../../../java/time/Duration.html#)`)` \u003cbr /\u003e |\n\n| Public methods ||\n|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is \"equal to\" this one. |\n| [Length](/reference/kotlin/android/health/connect/datatypes/units/Length) | [getDistance](#getDistance())`()` Returns the total distance that must be covered to complete this goal. |\n| [Duration](../../../../java/time/Duration.html#) | [getDuration](#getDuration())`()` Returns the total duration that must elapse to complete this goal. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` \u003cbr /\u003e |\n\nPublic constructors\n-------------------\n\n### DistanceWithVariableRestGoal\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nAlso in [U Extensions 13](https://developer.android.com/sdkExtensions) \n\n```\nDistanceWithVariableRestGoal(\n distance: Length, \n duration: Duration)\n```\n\n| Parameters ||\n|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `distance` | [Length](/reference/kotlin/android/health/connect/datatypes/units/Length): The total distance that must be covered to complete the goal. This value cannot be `null`. |\n| `duration` | [Duration](../../../../java/time/Duration.html#): The total duration that must elapse to complete the goal. This value cannot be `null`. |\n\nPublic methods\n--------------\n\n### equals\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun equals(other: Any?): Boolean\n```\n\nIndicates whether some other object is \"equal to\" this one.\n\nThe `equals` method implements an equivalence relation on non-null object references:\n\n- It is *reflexive* : for any non-null reference value `x`, `x.equals(x)` should return `true`.\n- 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`.\n- 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`.\n- 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.\n- For any non-null reference value `x`, `x.equals(null)` should return `false`.\n\nAn 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.\n\n| Parameters ||\n|-------|---------------------------------------------|\n| `obj` | the reference object with which to compare. |\n| `o` | This value may be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if this object is the same as the obj argument; `false` otherwise. |\n\n### getDistance\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nAlso in [U Extensions 13](https://developer.android.com/sdkExtensions) \n\n```\nfun getDistance(): Length\n```\n\nReturns the total distance that must be covered to complete this goal.\n\n| Return ||\n|---------------------------------------------------------------------------|------------------------------|\n| [Length](/reference/kotlin/android/health/connect/datatypes/units/Length) | This value cannot be `null`. |\n\n### getDuration\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \nAlso in [U Extensions 13](https://developer.android.com/sdkExtensions) \n\n```\nfun getDuration(): Duration\n```\n\nReturns the total duration that must elapse to complete this goal.\n\n| Return ||\n|--------------------------------------------------|------------------------------|\n| [Duration](../../../../java/time/Duration.html#) | This value cannot be `null`. |\n\n### hashCode\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun hashCode(): Int\n```\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |"]]
