HawaiiTime (Hawaii Framework 2.0.0.M13 API)

java.lang.Object
- org.hawaiiframework.time.HawaiiTime

```
public class HawaiiTime
extends java.lang.Object
```
This class provides a application wide Clock reference to instantiate new java.time date and time objects.
It provides convenient methods to use a fixed date time which is particular useful for unit testing but also to change the date time in a running application to test how it behaves on a given date or time.
Be aware that third-party libraries being used by the application do obviously not use HawaiiTime and probably instantiate date and time objects based on the System time.

Since:

2.0.0

Author:

Marcel Overdijk

Field Summary

Fields
Modifier and Type Field and Description

protected static java.time.ZoneId DEFAULT_ZONE
The default zone.

Fields
Modifier and Type	Field and Description
`protected static java.time.ZoneId`	`DEFAULT_ZONE` The default zone.

Constructor Summary

Constructors
Constructor and Description
`HawaiiTime()` Constructs a new `HawaiiTime` with the default `DEFAULT_ZONE`.
`HawaiiTime(java.time.Clock clock)` Constructs a new `HawaiiTime` with the supplied clock.
`HawaiiTime(java.time.ZoneId zone)` Constructs a new `HawaiiTime` with the supplied zone.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.time.Clock`	`getClock()` Returns the clock used by this `HawaiiTime`.
`java.time.ZoneId`	`getZone()` Returns the zone used by this `HawaiiTime`.
`java.time.Instant`	`instant()` Returns the current `Instant`.
`java.time.LocalDate`	`localDate()` Returns the current `LocalDate`.
`java.time.LocalDateTime`	`localDateTime()` Returns the current `LocalDateTime`.
`java.time.LocalTime`	`localTime()` Returns the current `LocalTime`.
`long`	`millis()` Returns the current `millis`.
`java.time.MonthDay`	`monthDay()` Returns the current `MonthDay`.
`java.time.OffsetDateTime`	`offsetDateTime()` Returns the current `OffsetDateTime`.
`java.time.OffsetTime`	`offsetTime()` Returns the current `OffsetTime`.
`void`	`setClock(java.time.Clock clock)` Sets the clock to be used by this `HawaiiTime`.
`void`	`setZone(java.time.ZoneId zone)` Sets the zone to be used by this `HawaiiTime`.
`void`	`useFixedClock(java.time.Clock clock)` Sets a fixed clock to be used.
`protected void`	`useFixedClock(java.time.Instant instant)` Sets a fixed clock to be used.
`protected void`	`useFixedClock(java.time.Instant instant, java.time.ZoneId zone)` Sets a fixed clock to be used.
`void`	`useFixedClock(java.time.LocalDateTime dateTime)` Sets a fixed clock to be used.
`void`	`useFixedClock(long millis)` Sets a fixed clock to be used.
`void`	`useFixedClock(java.time.OffsetDateTime dateTime)` Sets a fixed clock to be used.
`void`	`useFixedClock(java.time.ZonedDateTime dateTime)` Sets a fixed clock to be used.
`void`	`useSystemClock()` Sets the system clock to be used.
`java.time.Year`	`year()` Returns the current `Year`.
`java.time.YearMonth`	`yearMonth()` Returns the current `YearMonth`.
`java.time.ZonedDateTime`	`zonedDateTime()` Returns the current `ZonedDateTime`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_ZONE
```
protected static final java.time.ZoneId DEFAULT_ZONE
```
    The default zone.
- Constructor Detail
  - HawaiiTime
```
public HawaiiTime()
```
    Constructs a new HawaiiTime with the default DEFAULT_ZONE.
  - HawaiiTime
```
public HawaiiTime(java.time.ZoneId zone)
```
    Constructs a new HawaiiTime with the supplied zone.
    
    Parameters:
    
    zone - the zone, not null
  - HawaiiTime
```
public HawaiiTime(java.time.Clock clock)
```
    Constructs a new HawaiiTime with the supplied clock. Also the ZoneId is derived from the supplied clock.
    
    Parameters:
    
    clock - the clock, not null
- Method Detail
  - getClock
```
public java.time.Clock getClock()
```
    Returns the clock used by this HawaiiTime.
    
    Returns:
    
    the clock
  - setClock
```
public void setClock(java.time.Clock clock)
```
    Sets the clock to be used by this HawaiiTime.
    
    Parameters:
    
    clock - the clock, not null
  - getZone
```
public java.time.ZoneId getZone()
```
    Returns the zone used by this HawaiiTime.
    
    Returns:
    
    the zone
  - setZone
```
public void setZone(java.time.ZoneId zone)
```
    Sets the zone to be used by this HawaiiTime.
    
    Parameters:
    
    zone - the zone
  - useFixedClock
```
public void useFixedClock(java.time.Clock clock)
```
    Sets a fixed clock to be used.
    
    Parameters:
    
    clock - the fixed clock, not null
  - useFixedClock
```
public void useFixedClock(long millis)
```
    Sets a fixed clock to be used.
    
    Parameters:
    
    millis - the millis since epoch
  - useFixedClock
```
public void useFixedClock(java.time.LocalDateTime dateTime)
```
    Sets a fixed clock to be used.
    
    Parameters:
    
    dateTime - the fixed date time, not null
  - useFixedClock
```
public void useFixedClock(java.time.OffsetDateTime dateTime)
```
    Sets a fixed clock to be used.
    
    Parameters:
    
    dateTime - the fixed date time, not null
  - useFixedClock
```
public void useFixedClock(java.time.ZonedDateTime dateTime)
```
    Sets a fixed clock to be used.
    
    Parameters:
    
    dateTime - the fixed date time, not null
  - useFixedClock
```
protected void useFixedClock(java.time.Instant instant)
```
    Sets a fixed clock to be used.
    
    Parameters:
    
    instant - the fixed instant, not null
  - useFixedClock
```
protected void useFixedClock(java.time.Instant instant,
                             java.time.ZoneId zone)
```
    Sets a fixed clock to be used.
    
    Parameters:
    
    instant - the fixed instant, not null
    
    zone - the fixed zone, not null
  - useSystemClock
```
public void useSystemClock()
```
    Sets the system clock to be used.
  - instant
```
public java.time.Instant instant()
```
    Returns the current Instant.
    
    Returns:
    
    the Instant
  - localDate
```
public java.time.LocalDate localDate()
```
    Returns the current LocalDate.
    
    Returns:
    
    the LocalDate
  - localDateTime
```
public java.time.LocalDateTime localDateTime()
```
    Returns the current LocalDateTime.
    
    Returns:
    
    the LocalDateTime
  - localTime
```
public java.time.LocalTime localTime()
```
    Returns the current LocalTime.
    
    Returns:
    
    the LocalTime
  - millis
```
public long millis()
```
    Returns the current millis.
    
    Returns:
    
    the millis
  - monthDay
```
public java.time.MonthDay monthDay()
```
    Returns the current MonthDay.
    
    Returns:
    
    the MonthDay
  - offsetDateTime
```
public java.time.OffsetDateTime offsetDateTime()
```
    Returns the current OffsetDateTime.
    
    Returns:
    
    the OffsetDateTime
  - offsetTime
```
public java.time.OffsetTime offsetTime()
```
    Returns the current OffsetTime.
    
    Returns:
    
    the OffsetTime
  - year
```
public java.time.Year year()
```
    Returns the current Year.
    
    Returns:
    
    Year
  - yearMonth
```
public java.time.YearMonth yearMonth()
```
    Returns the current YearMonth.
    
    Returns:
    
    the YearMonth
  - zonedDateTime
```
public java.time.ZonedDateTime zonedDateTime()
```
    Returns the current ZonedDateTime.
    
    Returns:
    
    the ZonedDateTime

Class HawaiiTime

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ZONE

Constructor Detail

HawaiiTime

HawaiiTime

HawaiiTime

Method Detail

getClock

setClock

getZone

setZone

useFixedClock

useFixedClock

useFixedClock

useFixedClock

useFixedClock

useFixedClock

useFixedClock

useSystemClock

instant

localDate

localDateTime

localTime

millis

monthDay

offsetDateTime

offsetTime

year

yearMonth

zonedDateTime