MenstrualCyclePhaseRecord.Builder

Kotlin |Java

public static final class MenstrualCyclePhaseRecord.Builder
extends Object

java.lang.Object
↳	android.health.connect.datatypes.MenstrualCyclePhaseRecord.Builder

Summary

Public constructors
`Builder(Metadata metadata, LocalDate date, int phase)`

Public methods
`MenstrualCyclePhaseRecord`	`build()`
`MenstrualCyclePhaseRecord.Builder`	`clearDayOfCycle()` Clears the day of cycle for this data.
`MenstrualCyclePhaseRecord.Builder`	`clearStartZoneOffset()` Clears the `ZoneOffset` of the user at the beginning of the measurement day.
`MenstrualCyclePhaseRecord.Builder`	`setDayOfCycle(int dayOfCycle)` Sets the day of cycle for this data.
`MenstrualCyclePhaseRecord.Builder`	`setStartZoneOffset(ZoneOffset zoneOffset)` Sets the `ZoneOffset` of the user at the beginning of the measurement day.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

public Builder (Metadata metadata, 
                LocalDate date, 
                int phase)

Parameters
`metadata`	`Metadata`: Metadata to be associated with the record. See `Metadata`. This value cannot be `null`.
`date`	`LocalDate`: The date of this record. This value cannot be `null`.
`phase`	`int`: The cycle phase for this record. Value is one of the following: `MenstrualCyclePhaseRecord.PHASE_FOLLICULAR` `MenstrualCyclePhaseRecord.PHASE_LUTEAL`

public MenstrualCyclePhaseRecord build ()

Returns
`MenstrualCyclePhaseRecord`	Object of `MenstrualCyclePhaseRecord` This value cannot be `null`.

public MenstrualCyclePhaseRecord.Builder clearDayOfCycle ()

Clears the day of cycle for this data.

Returns
`MenstrualCyclePhaseRecord.Builder`	This value cannot be `null`.

public MenstrualCyclePhaseRecord.Builder clearStartZoneOffset ()

Clears the ZoneOffset of the user at the beginning of the measurement day.

Returns
`MenstrualCyclePhaseRecord.Builder`	This value cannot be `null`.

public MenstrualCyclePhaseRecord.Builder setDayOfCycle (int dayOfCycle)

Sets the day of cycle for this data.

Parameters
`dayOfCycle`	`int`: Value is between 1 and 180 inclusive

Returns
`MenstrualCyclePhaseRecord.Builder`	This value cannot be `null`.

Throws
`IllegalArgumentException`	if the provided `dayOfCycle` is less than 1 or more than 180.

public MenstrualCyclePhaseRecord.Builder setStartZoneOffset (ZoneOffset zoneOffset)

Sets the ZoneOffset of the user at the beginning of the measurement day.

If not set, the system default zone offset will be used.

Parameters
`zoneOffset`	`ZoneOffset`: This value cannot be `null`.

Returns
`MenstrualCyclePhaseRecord.Builder`	This value cannot be `null`.