CervicalMucusRecord.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.RestrictTo
import androidx.annotation.StringDef
import androidx.health.connect.client.records.CervicalMucusRecord.Appearances
import androidx.health.connect.client.records.CervicalMucusRecord.Sensations
import androidx.health.connect.client.records.metadata.Metadata
import java.time.Instant
import java.time.ZoneOffset
/**
* Captures the description of cervical mucus. Each record represents a self-assessed description of
* cervical mucus for a user. All fields are optional and can be used to describe the look and feel
* of cervical mucus.
*/
public class CervicalMucusRecord(
/**
* The consistency of the user's cervical mucus. Optional field. Allowed values:
* [Appearance].
*
* @see Appearance
*/
@property:Appearances public val appearance: String? = null,
/**
* The feel of the user's cervical mucus. Optional field. Allowed values:
* [Sensation].
*
* @see Sensation
*/
@property:Sensations public val sensation: String? = null,
override val time: Instant,
override val zoneOffset: ZoneOffset?,
override val metadata: Metadata = Metadata.EMPTY,
) : InstantaneousRecord {
override fun equals(other: Any?): Boolean {
if (this === other) return true
if (other !is CervicalMucusRecord) return false
if (appearance != other.appearance) return false
if (sensation != other.sensation) return false
if (time != other.time) return false
if (zoneOffset != other.zoneOffset) return false
if (metadata != other.metadata) return false
return true
}
override fun hashCode(): Int {
var result = 0
result = 31 * result + appearance.hashCode()
result = 31 * result + sensation.hashCode()
result = 31 * result + time.hashCode()
result = 31 * result + (zoneOffset?.hashCode() ?: 0)
result = 31 * result + metadata.hashCode()
return result
}
/** List of supported Cervical Mucus Sensation types on Health Platform. */
public object Sensation {
const val LIGHT = "light"
const val MEDIUM = "medium"
const val HEAVY = "heavy"
}
/**
* List of supported Cervical Mucus Sensation types on Health Platform.
* @suppress
*/
@Retention(AnnotationRetention.SOURCE)
@StringDef(
value =
[
Sensation.LIGHT,
Sensation.MEDIUM,
Sensation.HEAVY,
]
)
@RestrictTo(RestrictTo.Scope.LIBRARY)
annotation class Sensations
/** The consistency or appearance of the user's cervical mucus. */
public object Appearance {
const val DRY = "dry"
const val STICKY = "sticky"
const val CREAMY = "creamy"
const val WATERY = "watery"
const val CLEAR = "clear"
}
/**
* The consistency or appearance of the user's cervical mucus.
* @suppress
*/
@Retention(AnnotationRetention.SOURCE)
@StringDef(
value =
[
Appearance.DRY,
Appearance.STICKY,
Appearance.CREAMY,
Appearance.WATERY,
Appearance.CLEAR,
]
)
@RestrictTo(RestrictTo.Scope.LIBRARY)
annotation class Appearances
}