org.openzen.zengarden.util

Class FlexDateTime

java.lang.Object

org.openzen.zengarden.util.FlexDateTime

public class FlexDateTime
extends java.lang.Object

Datetime of which each field is optional. Can be used to denote only date, only time, a month or year, or a date of which some fields are unknown or irrevelant.

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN
static double	UNKNOWN_TIMEZONE

Constructor Summary

Constructors

Constructor and Description
FlexDateTime(int year, int month, int day) Constructs a FlexDateTime object using the given fields.
FlexDateTime(int year, int month, int day, int hours, int minutes) Constructs a FlexDateTime object using the given fields.
FlexDateTime(int year, int month, int day, int hours, int minutes, int seconds, int milliseconds, java.time.ZoneOffset timezone) Constructs a FlexDateTime object using the given fields.
FlexDateTime(java.time.LocalDateTime dateTimeUTC) Converts the given LocalDateTime to FlexDateTime.
FlexDateTime(long value) Constructs a FlexDateTime object from an encoded value.

Method Summary

Modifier and Type	Method and Description
int	getDay() Returns the day part of this datetime (1-12).
int	getHour() Returns the hour part of this datetime (0-23).
java.time.OffsetDateTime	getLowerBound() Returns the lower bound of this object, which is the smallest possible value that would fit all the given bounds.
int	getMillisecond() Returns the millisecond part of this datetime (0-999).
int	getMinute() Returns the minute part of this datetime (0-59).
int	getMonth() Returns the month part of this datetime (1-12).
int	getSecond() Returns the second part of this datetime (0-59).
java.time.ZoneOffset	getTimezoneOffset() Returns the zone offset part of this datetime.
java.time.OffsetDateTime	getUpperBound() Returns the upper bound of this object, which is the largest possible value that would fit all the given bounds.
long	getValue() Encodes the contents of this object into a long value.
int	getYear() Returns the year part of this datetime.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

UNKNOWN_TIMEZONE

public static final double UNKNOWN_TIMEZONE

See Also:

Constant Field Values

Constructor Detail

FlexDateTime

public FlexDateTime(java.time.LocalDateTime dateTimeUTC)

Converts the given LocalDateTime to FlexDateTime.

Parameters:

dateTimeUTC - original datetime

FlexDateTime

public FlexDateTime(int year,
                    int month,
                    int day)

Constructs a FlexDateTime object using the given fields. Use -1 for fields that are unknown.

Parameters:

year - year [0, 4000] or -1

month - month [1, 12] or -1

day - day [1, 31] or -1

FlexDateTime

public FlexDateTime(int year,
                    int month,
                    int day,
                    int hours,
                    int minutes)

Constructs a FlexDateTime object using the given fields. Use -1 for fields that are unknown.

Parameters:

year - year [0, 4000] or -1

month - month [1, 12] or -1

day - day [1, 31] or -1

hours - hours [0, 23] or -1

minutes - minutes [0, 59] or -1

FlexDateTime

public FlexDateTime(int year,
                    int month,
                    int day,
                    int hours,
                    int minutes,
                    int seconds,
                    int milliseconds,
                    java.time.ZoneOffset timezone)

Constructs a FlexDateTime object using the given fields. Use -1 for fields that are unknown.

Parameters:

year - year [0, 4000] or -1

month - month [1, 12] or -1

day - day [1, 31] or -1

hours - hours [0, 23] or -1

minutes - minutes [0, 59] or -1

seconds - seconds [0, 59] or -1

milliseconds - milliseconts [0, 999] or -1

timezone - timezone, can be null

FlexDateTime

public FlexDateTime(long value)

Constructs a FlexDateTime object from an encoded value.

Parameters:

value - encoded value

Method Detail

getValue

public long getValue()

Encodes the contents of this object into a long value.

Returns:

encoded value

getYear

public int getYear()

Returns the year part of this datetime. Returns -1 if unknown.

Returns:

year

getMonth

public int getMonth()

Returns the month part of this datetime (1-12). Returns -1 if unknown.

Returns:

month (1 - based)

getDay

public int getDay()

Returns the day part of this datetime (1-12). Returns -1 if unknown.

Returns:

day (1 - based)

getHour

public int getHour()

Returns the hour part of this datetime (0-23). Returns -1 if unknown.

Returns:

hour (1 - based)

getMinute

public int getMinute()

Returns the minute part of this datetime (0-59). Returns -1 if unknown.

Returns:

minute

getSecond

public int getSecond()

Returns the second part of this datetime (0-59). Returns -1 if unknown.

Returns:

second

getMillisecond

public int getMillisecond()

Returns the millisecond part of this datetime (0-999). Returns -1 if unknown.

Returns:

millisecond

getTimezoneOffset

public java.time.ZoneOffset getTimezoneOffset()

Returns the zone offset part of this datetime. Returns null if unknown.

Returns:

zone offset

getLowerBound

public java.time.OffsetDateTime getLowerBound()

Returns the lower bound of this object, which is the smallest possible value that would fit all the given bounds.

Returns:

lower bound

getUpperBound

public java.time.OffsetDateTime getUpperBound()

Returns the upper bound of this object, which is the largest possible value that would fit all the given bounds.

Returns:

upper bound