org.fujion.common

Class DateTimeWrapper

java.lang.Object

org.fujion.common.DateTimeWrapper

All Implemented Interfaces:

Comparable<DateTimeWrapper>

public class DateTimeWrapper
extends Object
implements Comparable<DateTimeWrapper>

Common wrapper for LocalDate, LocalDateTime, and Date instances.

Constructor Summary

Constructors

Constructor and Description
DateTimeWrapper(Date date) Wrap a legacy Date value.
DateTimeWrapper(LocalDate date) Wrap a LocalDate value.
DateTimeWrapper(LocalDateTime datetime) Wrap a LocalDateTime value.
DateTimeWrapper(OffsetDateTime datetime) Wrap an OffsetDateTime value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DateTimeWrapper dtw) Compares two DateTimeWrapper instances.
LocalDate	getDate() Returns the wrapped date/time as a LocalDate value.
LocalDateTime	getDateTime() Returns the wrapped date/time as a LocalDateTime value.
Date	getLegacyDate() Returns the wrapped date/time as a legacy Date value.
OffsetDateTime	getOffsetDateTime() Returns the wrapped date/time as an OffsetDateTime value.
LocalTime	getTime() Returns the time component of the wrapped value.
boolean	hasTime() Returns true if the wrapped date/time has a time component.
static DateTimeWrapper	now() Returns a wrapper for the current date and time.
static DateTimeWrapper	parse(String value) Converts a string value to a DateTimeWrapper.
static DateTimeWrapper	today() Returns a wrapper for the current date.
String	toISOString() Returns the wrapped date/time as an ISO-formatted date or date/time.
String	toString() Returns the wrapped date/time in a form suitable for display.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DateTimeWrapper

public DateTimeWrapper(LocalDate date)

Wrap a LocalDate value.

Parameters:

date - A LocalDate value.

DateTimeWrapper

public DateTimeWrapper(LocalDateTime datetime)

Wrap a LocalDateTime value.

Parameters:

datetime - A LocalDateTime value.

DateTimeWrapper

public DateTimeWrapper(OffsetDateTime datetime)

Wrap an OffsetDateTime value.

Parameters:

datetime - An OffsetDateTime value.

DateTimeWrapper

public DateTimeWrapper(Date date)

Wrap a legacy Date value.

Parameters:

date - A legacy Date value.

Method Detail

now

public static DateTimeWrapper now()

Returns a wrapper for the current date and time.

Returns:

Current date and time.

today

public static DateTimeWrapper today()

Returns a wrapper for the current date.

Returns:

Current date.

parse

public static DateTimeWrapper parse(String value)

Converts a string value to a DateTimeWrapper.

Parameters:

value - The value to parse.

Returns:

A DateTimeWrapper instance.

Throws:

IllegalArgumentException - If the input value could not be parsed.

hasTime

public boolean hasTime()

Returns true if the wrapped date/time has a time component.

Returns:

True if the wrapped date/time has a time component.

getLegacyDate

public Date getLegacyDate()

Returns the wrapped date/time as a legacy Date value. If the wrapped value has no time component, the returned value will have a time set to midnight.

Returns:

The wrapped value as a legacy date value.

getOffsetDateTime

public OffsetDateTime getOffsetDateTime()

Returns the wrapped date/time as an OffsetDateTime value. If the wrapped value contains no time component, it will be coerced to one with a time beginning at the start of the day.

Returns:

The wrapped value as a LocalDateTime.

getDateTime

public LocalDateTime getDateTime()

Returns the wrapped date/time as a LocalDateTime value. If the wrapped value contains no time component, it will be coerced to one with a time beginning at the start of the day.

Returns:

The wrapped value as a LocalDateTime.

getDate

public LocalDate getDate()

Returns the wrapped date/time as a LocalDate value. If the wrapped value contains a time component, it will be coerced to a value with the time component removed.

Returns:

The wrapped value as a LocalDateTime.

getTime

public LocalTime getTime()

Returns the time component of the wrapped value. If there is no time component, null is returned.

Returns:

The time component of the wrapped value (possibly null).

compareTo

public int compareTo(DateTimeWrapper dtw)

Compares two DateTimeWrapper instances. Wrapped values are coerced as necessary.

Specified by:

compareTo in interface Comparable<DateTimeWrapper>

Parameters:

dtw - A DateTimeWrapper against which to compare.

Returns:

The result of the comparison.

toISOString

public String toISOString()

Returns the wrapped date/time as an ISO-formatted date or date/time.

Returns:

An ISO-formatted date or date/time.

toString

public String toString()

Returns the wrapped date/time in a form suitable for display.

Overrides:

toString in class Object

Returns:

Text version of the wrapped date/time.