StepsRecord.kt

/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package androidx.health.connect.client.records

import androidx.annotation.IntRange
import androidx.health.connect.client.aggregate.AggregateMetric
import androidx.health.connect.client.records.metadata.Metadata
import java.time.Instant
import java.time.ZoneOffset

/**
 * Captures the number of steps taken since the last reading. Each step is only reported once so
 * records shouldn't have overlapping time. The start time of each record should represent the start
 * of the interval in which steps were taken.
 *
 * The start time must be equal to or greater than the end time of the previous record. Adding all
 * of the values together for a period of time calculates the total number of steps during that
 * period.
 */
public class StepsRecord(
    override val startTime: Instant,
    override val startZoneOffset: ZoneOffset?,
    override val endTime: Instant,
    override val endZoneOffset: ZoneOffset?,
    /** Count. Required field. Valid range: 1-1000000. */
    @IntRange(from = 1, to = 1000_000)
    public val count: Long,
    override val metadata: Metadata = Metadata.EMPTY,
) : IntervalRecord {
    init {
        count.requireNotLess(other = 1, name = "count")
        count.requireNotMore(other = 1000_000, name = "count")
        require(startTime.isBefore(endTime)) { "startTime must be before endTime." }
    }
    override fun equals(other: Any?): Boolean {
        if (this === other) return true
        if (other !is StepsRecord) return false

        if (count != other.count) return false
        if (startTime != other.startTime) return false
        if (startZoneOffset != other.startZoneOffset) return false
        if (endTime != other.endTime) return false
        if (endZoneOffset != other.endZoneOffset) return false
        if (metadata != other.metadata) return false

        return true
    }

    override fun hashCode(): Int {
        var result = 0
        result = 31 * result + count.hashCode()
        result = 31 * result + (startZoneOffset?.hashCode() ?: 0)
        result = 31 * result + endTime.hashCode()
        result = 31 * result + (endZoneOffset?.hashCode() ?: 0)
        result = 31 * result + metadata.hashCode()
        return result
    }

    companion object {
        /**
         * Metric identifier to retrieve the total steps count from
         * [androidx.health.connect.client.aggregate.AggregationResult].
         */
        @JvmField
        val COUNT_TOTAL: AggregateMetric<Long> =
            AggregateMetric.longMetric("Steps", AggregateMetric.AggregationType.TOTAL, "count")
    }
}