Stage
class Stage
| kotlin.Any | |
| ↳ | android.health.connect.datatypes.SleepSessionRecord.Stage |
Captures the user's length and type of sleep. Each record represents a time interval for a stage of sleep.
The start time of the record represents the start and end time of the sleep stage and always need to be included.
Summary
| Public constructors | |
|---|---|
|
Builds |
|
| Public methods | |
|---|---|
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open Instant |
Returns end time of this stage. |
| open Instant |
Returns start time of this stage. |
| open Int |
getType()Returns stage type. |
| open Int |
hashCode()Returns a hash code value for the object. |
Public constructors
Stage
Stage(
startTime: Instant,
endTime: Instant,
stageType: Int)
Builds Stage instance
| Parameters | |
|---|---|
startTime |
Instant: start time of the stage. This value cannot be null. |
endTime |
Instant: end time of the stage. Must not be earlier than start time. This value cannot be null. |
stageType |
Int: type of the stage. One of StageType Value is one of the following:
|
Public methods
equals
open 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. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getEndTime
open fun getEndTime(): Instant
Returns end time of this stage.
| Return | |
|---|---|
Instant |
This value cannot be null. |
getStartTime
open fun getStartTime(): Instant
Returns start time of this stage.
| Return | |
|---|---|
Instant |
This value cannot be null. |
getType
open fun getType(): Int
Returns stage type.
hashCode
open 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. |