org.ojalgo.type

Class CalendarDate

java.lang.Object

org.ojalgo.type.CalendarDate

All Implemented Interfaces:

Comparable<CalendarDate>, Temporal, TemporalAccessor

public final class CalendarDate
extends Object
implements Temporal, Comparable<CalendarDate>

Originally, long before Java 8 and its new Date and Time API, this class was designed to provide an immutable complement to the existing Date and Calendar classes and to have easy/direct access to the underlying epoch millisecond value.

In terms of the newer API it most closely corresponds to an Instant, but does not have its nanosecond granularity. At one point the plan was to remove and replace this class with Instant, but working with a single long as an "instant" representation is very practical and efficient.

It has been retrofitted to implement the Temporal interface.

Author:

apete

See Also:

CalendarDateDuration, CalendarDateUnit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CalendarDate.Resolution Extends TemporalAdjuster but also loosely corresponds to a TemporalUnit and/or TemporalAmount.

Field Summary

Fields

Modifier and Type	Field and Description
long	millis An "instant" with ms precision.

Constructor Summary

Constructors

Constructor and Description
CalendarDate()
CalendarDate(Calendar calendar)
CalendarDate(Date date)
CalendarDate(long timeInMillis)
CalendarDate(String sqlString)

Method Summary

Modifier and Type	Method and Description
Calendar	adjustInto(Calendar temporal)
Date	adjustInto(Date temporal)
<T extends Temporal> T	adjustInto(T temporal)
int	compareTo(CalendarDate ref)
boolean	equals(Object obj)
CalendarDate	filter(CalendarDateUnit resolution)
static CalendarDate	from(TemporalAccessor temporal)
long	getLong(TemporalField field)
int	hashCode()
boolean	isSupported(TemporalField field)
boolean	isSupported(TemporalUnit unit)
static CalendarDate	make(Calendar calendar, CalendarDate.Resolution resolution)
static CalendarDate	make(CalendarDate.Resolution resolution)
static CalendarDate	make(Date date, CalendarDate.Resolution resolution)
static CalendarDate	make(long timeInMIllis, CalendarDate.Resolution resolution)
static CalendarDate	now()
Temporal	plus(long amountToAdd, TemporalUnit unit)
CalendarDate	step(CalendarDateDuration aStepDuration) Only steps with the int part of CalendarDateDuration.measure .
CalendarDate	step(CalendarDateUnit aStepUnit)
CalendarDate	step(int aStepCount, CalendarDateUnit aStepUnit)
Calendar	toCalendar()
static Calendar	toCalendar(Instant instant)
static Calendar	toCalendar(Instant instant, Locale locale)
static Calendar	toCalendar(Instant instant, TimeZone zone)
static Calendar	toCalendar(Instant instant, TimeZone zone, Locale locale)
Calendar	toCalendar(Locale locale)
Calendar	toCalendar(TimeZone zone)
Calendar	toCalendar(TimeZone zone, Locale locale)
Date	toDate()
static Date	toDate(Instant instant)
Instant	toInstant()
static LocalDate	toLocalDate(Calendar calendar)
static LocalDate	toLocalDate(Instant instant, ZoneId zone)
LocalDate	toLocalDate(ZoneOffset offset)
static LocalDateTime	toLocalDateTime(Instant instant, ZoneId zone)
LocalDateTime	toLocalDateTime(ZoneOffset offset)
static LocalTime	toLocalTime(Instant instant, ZoneId zone)
LocalTime	toLocalTime(ZoneOffset offset)
static OffsetDateTime	toOffsetDateTime(Instant instant, ZoneId zone)
static OffsetDateTime	toOffsetDateTime(Instant instant, ZoneId zone, Instant zoneToOffsetConversionInstant)
static OffsetDateTime	toOffsetDateTime(Instant instant, ZoneOffset offset)
OffsetDateTime	toOffsetDateTime(ZoneOffset offset)
Date	toSqlDate() Deprecated. v39
Date	toSqlTime() Deprecated. v39
Date	toSqlTimestamp() Deprecated. v39
String	toString()
static ZonedDateTime	toZonedDateTime(Instant instant, ZoneId zone)
ZonedDateTime	toZonedDateTime(ZoneOffset offset)
long	until(Temporal endExclusive, TemporalUnit unit)
static CalendarDate	valueOf(Instant instant)
static CalendarDate	valueOf(OffsetDateTime offsetDateTime)
static CalendarDate	valueOf(ZonedDateTime zonedDateTime)
CalendarDate	with(TemporalAdjuster adjuster)
CalendarDate	with(TemporalField field, long newValue)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.time.temporal.Temporal

minus, minus, plus

Methods inherited from interface java.time.temporal.TemporalAccessor

get, query, range

Field Detail

millis

public final long millis

An "instant" with ms precision. Equivalent to what is returned by Instant.toEpochMilli() and/or System.currentTimeMillis().

Constructor Detail

CalendarDate

public CalendarDate()

CalendarDate

public CalendarDate(Calendar calendar)

CalendarDate

public CalendarDate(Date date)

CalendarDate

public CalendarDate(long timeInMillis)

CalendarDate

public CalendarDate(String sqlString)
             throws RecoverableCondition

Parameters:

sqlString - The String to parse

Throws:

RecoverableCondition - When(if parsing the String fails

Method Detail

from

public static CalendarDate from(TemporalAccessor temporal)

make

public static CalendarDate make(Calendar calendar,
                                CalendarDate.Resolution resolution)

make

public static CalendarDate make(CalendarDate.Resolution resolution)

make

public static CalendarDate make(Date date,
                                CalendarDate.Resolution resolution)

make

public static CalendarDate make(long timeInMIllis,
                                CalendarDate.Resolution resolution)

now

public static CalendarDate now()

toCalendar

public static Calendar toCalendar(Instant instant)

toCalendar

public static Calendar toCalendar(Instant instant,
                                  Locale locale)

toCalendar

public static Calendar toCalendar(Instant instant,
                                  TimeZone zone)

toCalendar

public static Calendar toCalendar(Instant instant,
                                  TimeZone zone,
                                  Locale locale)

toDate

public static Date toDate(Instant instant)

toLocalDate

public static LocalDate toLocalDate(Calendar calendar)

toLocalDate

public static LocalDate toLocalDate(Instant instant,
                                    ZoneId zone)

toLocalDateTime

public static LocalDateTime toLocalDateTime(Instant instant,
                                            ZoneId zone)

toLocalTime

public static LocalTime toLocalTime(Instant instant,
                                    ZoneId zone)

toOffsetDateTime

public static OffsetDateTime toOffsetDateTime(Instant instant,
                                              ZoneId zone)

toOffsetDateTime

public static OffsetDateTime toOffsetDateTime(Instant instant,
                                              ZoneId zone,
                                              Instant zoneToOffsetConversionInstant)

toOffsetDateTime

public static OffsetDateTime toOffsetDateTime(Instant instant,
                                              ZoneOffset offset)

toZonedDateTime

public static ZonedDateTime toZonedDateTime(Instant instant,
                                            ZoneId zone)

valueOf

public static CalendarDate valueOf(Instant instant)

valueOf

public static CalendarDate valueOf(OffsetDateTime offsetDateTime)

valueOf

public static CalendarDate valueOf(ZonedDateTime zonedDateTime)

adjustInto

public Calendar adjustInto(Calendar temporal)

adjustInto

public Date adjustInto(Date temporal)

adjustInto

public <T extends Temporal> T adjustInto(T temporal)

compareTo

public int compareTo(CalendarDate ref)

Specified by:

compareTo in interface Comparable<CalendarDate>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

filter

public CalendarDate filter(CalendarDateUnit resolution)

getLong

public long getLong(TemporalField field)

Specified by:

getLong in interface TemporalAccessor

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isSupported

public boolean isSupported(TemporalField field)

Specified by:

isSupported in interface TemporalAccessor

isSupported

public boolean isSupported(TemporalUnit unit)

Specified by:

isSupported in interface Temporal

plus

public Temporal plus(long amountToAdd,
                     TemporalUnit unit)

Specified by:

plus in interface Temporal

step

public CalendarDate step(CalendarDateDuration aStepDuration)

Only steps with the int part of CalendarDateDuration.measure .

step

public CalendarDate step(CalendarDateUnit aStepUnit)

step

public CalendarDate step(int aStepCount,
                         CalendarDateUnit aStepUnit)

toCalendar

public Calendar toCalendar()

toCalendar

public Calendar toCalendar(Locale locale)

toCalendar

public Calendar toCalendar(TimeZone zone)

toCalendar

public Calendar toCalendar(TimeZone zone,
                           Locale locale)

toDate

public Date toDate()

toInstant

public Instant toInstant()

toLocalDate

public LocalDate toLocalDate(ZoneOffset offset)

toLocalDateTime

public LocalDateTime toLocalDateTime(ZoneOffset offset)

toLocalTime

public LocalTime toLocalTime(ZoneOffset offset)

toOffsetDateTime

public OffsetDateTime toOffsetDateTime(ZoneOffset offset)

toSqlDate

@Deprecated
public Date toSqlDate()

Deprecated. v39

toSqlTime

@Deprecated
public Date toSqlTime()

Deprecated. v39

toSqlTimestamp

@Deprecated
public Date toSqlTimestamp()

Deprecated. v39

toString

public String toString()

Overrides:

toString in class Object

toZonedDateTime

public ZonedDateTime toZonedDateTime(ZoneOffset offset)

until

public long until(Temporal endExclusive,
                  TemporalUnit unit)

Specified by:

until in interface Temporal

with

public CalendarDate with(TemporalAdjuster adjuster)

Specified by:

with in interface Temporal

with

public CalendarDate with(TemporalField field,
                         long newValue)

Specified by:

with in interface Temporal