MenstruationFlowRecord

public final class MenstruationFlowRecord implements Record


Captures a description of how heavy a user's menstrual flow was (light, medium, or heavy). Each record represents a description of how heavy the user's menstrual bleeding was.

Summary

Constants

static final int
static final int
static final int
static final int

Public constructors

MenstruationFlowRecord(
    @NonNull Instant time,
    ZoneOffset zoneOffset,
    int flow,
    @NonNull Metadata metadata
)

Public methods

boolean
equals(Object other)
final int

How heavy the user's menstrual flow was.

@NonNull Metadata

Set of common metadata associated with the written record.

@NonNull Instant

Time the record happened.

ZoneOffset

User experienced zone offset at time, or null if unknown.

int

Constants

FLOW_HEAVY

public static final int FLOW_HEAVY = 3

FLOW_LIGHT

public static final int FLOW_LIGHT = 1

FLOW_MEDIUM

public static final int FLOW_MEDIUM = 2

FLOW_UNKNOWN

public static final int FLOW_UNKNOWN = 0

Public constructors

MenstruationFlowRecord

Added in 1.1.0-alpha07
public MenstruationFlowRecord(
    @NonNull Instant time,
    ZoneOffset zoneOffset,
    int flow,
    @NonNull Metadata metadata
)

Public methods

equals

public boolean equals(Object other)

getFlow

Added in 1.1.0-alpha07
public final int getFlow()

How heavy the user's menstrual flow was. Optional field.

getMetadata

Added in 1.1.0-alpha07
public @NonNull Metadata getMetadata()

Set of common metadata associated with the written record.

getTime

Added in 1.1.0-alpha07
public @NonNull Instant getTime()

Time the record happened.

getZoneOffset

Added in 1.1.0-alpha07
public ZoneOffset getZoneOffset()

User experienced zone offset at time, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.

hashCode

public int hashCode()