HydrationRecord.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.health.connect.client.aggregate.AggregateMetric
import androidx.health.connect.client.records.metadata.Metadata
import androidx.health.connect.client.units.Volume
import java.time.Instant
import java.time.ZoneOffset
/** Captures how much water a user drank in a single drink. */
public class HydrationRecord(
/** Volume of water in [Volume] unit. Required field. Valid range: 0-100 liters. */
public val volume: Volume,
override val startTime: Instant,
override val startZoneOffset: ZoneOffset?,
override val endTime: Instant,
override val endZoneOffset: ZoneOffset?,
override val metadata: Metadata = Metadata.EMPTY,
) : IntervalRecord {
init {
volume.requireNotLess(other = volume.zero(), name = "volume")
}
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (other !is HydrationRecord) return false
if (volume != other.volume) 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 = volume.hashCode()
result = 31 * result + startTime.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 total hydration from
* [androidx.health.connect.client.aggregate.AggregationResult].
*/
@JvmField
val VOLUME_TOTAL: AggregateMetric<Volume> =
AggregateMetric.doubleMetric(
dataTypeName = "Hydration",
aggregationType = AggregateMetric.AggregationType.TOTAL,
fieldName = "volume",
mapper = Volume::liters,
)
}
}