OvulationTestRecord


public final class OvulationTestRecord implements Record


Each record represents the result of an ovulation test.

Summary

Constants

static final int

High fertility.

static final int

Inconclusive result.

static final int

Negative fertility (may also be referred as "low" fertility).

static final int

Positive fertility (may also be referred as "peak" fertility).

Public constructors

OvulationTestRecord(
    @NonNull Instant time,
    ZoneOffset zoneOffset,
    int result,
    @NonNull Metadata metadata
)

Public methods

boolean
equals(Object other)
@NonNull Metadata

Set of common metadata associated with the written record.

final int

The result of a user's ovulation test, which shows if they're ovulating or not.

@NonNull Instant

Time the record happened.

ZoneOffset

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

int
@NonNull String

Constants

RESULT_HIGH

public static final int RESULT_HIGH = 2

High fertility. Refers to a rise in estrogen or luteinizing hormone that may signal the fertile window (time in the menstrual cycle when conception is likely to occur).

RESULT_INCONCLUSIVE

public static final int RESULT_INCONCLUSIVE = 0

Inconclusive result. Refers to ovulation test results that are indeterminate (e.g. may be testing malfunction, user error, etc.). ". Any unknown value will also be returned as RESULT_INCONCLUSIVE.

RESULT_NEGATIVE

public static final int RESULT_NEGATIVE = 3

Negative fertility (may also be referred as "low" fertility). Refers to the time in the cycle where fertility/conception is expected to be low.

RESULT_POSITIVE

public static final int RESULT_POSITIVE = 1

Positive fertility (may also be referred as "peak" fertility). Refers to the peak of the luteinizing hormone (LH) surge and ovulation is expected to occur in 10-36 hours.

Public constructors

OvulationTestRecord

Added in 1.1.0-alpha10
public OvulationTestRecord(
    @NonNull Instant time,
    ZoneOffset zoneOffset,
    int result,
    @NonNull Metadata metadata
)

Public methods

equals

public boolean equals(Object other)

getMetadata

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

Set of common metadata associated with the written record.

getResult

Added in 1.1.0-alpha10
public final int getResult()

The result of a user's ovulation test, which shows if they're ovulating or not. Required field.

getTime

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

Time the record happened.

getZoneOffset

Added in 1.1.0-alpha10
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()

toString

public @NonNull String toString()