public final Class PaxDate

Overrides default java.time.chrono.ChronoLocalDate.atTime.

Doc from java.time.chrono.ChronoLocalDate.atTime.

Combines this date with a time to create a ChronoLocalDateTime.

This returns a ChronoLocalDateTime formed from this date at the specified time. All possible combinations of date and time are valid.

Parameters

localTime:LocalTime

the local time to use, not null

Returns:ChronoLocalDateTime<PaxDate>

the local date-time formed from this date and the specified time, not null

Annotations

@Override

@SuppressWarnings:unchecked

Hides java.time.chrono.ChronoLocalDate.from.

Obtains a PaxDate from a temporal object.

This obtains a date in the Pax calendar system based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of PaxDate.

The conversion typically uses the EPOCH_DAY field, which is standardized across calendar systems.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, PaxDate::from.

Parameters

temporal:TemporalAccessor

the temporal object to convert, not null

Returns:PaxDate

the date in the Pax calendar system, not null

Exceptions

DateTimeException:

if unable to convert to a PaxDate

Implements java.time.chrono.ChronoLocalDate.getChronology.

Gets the chronology of this date, which is the Pax calendar system.

The Chronology represents the calendar system in use. The era and other fields in ChronoField are defined by the chronology.

Returns:PaxChronology

the Pax chronology, not null

Annotations

@Override

Overrides default java.time.chrono.ChronoLocalDate.getEra.

Gets the era applicable at this date.

The Pax calendar system has two eras, 'CE' and 'BCE', defined by PaxEra.

Returns:PaxEra

the era applicable at this date, not null

Annotations

@Override

Implements java.time.chrono.ChronoLocalDate.lengthOfMonth.

Returns the length of the month represented by this date.

This returns the length of the month in days. Month lengths do not match those of the ISO calendar system.

Returns:int

the length of the month in days, from 7 to 28

Annotations

@Override

Overrides default java.time.chrono.ChronoLocalDate.lengthOfYear.

Doc from java.time.chrono.ChronoLocalDate.lengthOfYear.

Returns the length of the year represented by this date, as defined by the calendar system.

This returns the length of the year in days.

The default implementation uses isLeapYear() and returns 365 or 366.

Returns:int

the length of the year in days

Annotations

@Override

Overrides default java.time.chrono.ChronoLocalDate.minus.

Doc from java.time.chrono.ChronoLocalDate.minus.

Returns an object of the same type as this object with an amount subtracted.

This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a java.time.Period but may be any other type implementing the TemporalAmount interface, such as java.time.Duration.

Some example code indicating how and why this method is used:

 date = date.minus(period);               // subtract a Period instance
 date = date.minus(duration);             // subtract a Duration instance
 date = date.minus(workingDays(6));       // example user-written workingDays method

Note that calling plus followed by minus is not guaranteed to return the same date-time.

Parameters

amount:TemporalAmount

Doc from java.time.temporal.Temporal.minus.

the amount to subtract, not null

Returns:PaxDate

Doc from java.time.temporal.Temporal.minus.

an object of the same type with the specified adjustment made, not null

Annotations

@Override

Overrides default java.time.chrono.ChronoLocalDate.minus.

Doc from java.time.chrono.ChronoLocalDate.minus.

Returns an object of the same type as this object with the specified period subtracted.

This method returns a new object based on this one with the specified period subtracted. For example, on a LocalDate, this could be used to subtract a number of years, months or days. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

Parameters

amountToSubtract:long

Doc from java.time.temporal.Temporal.minus.

the amount of the specified unit to subtract, may be negative

unit:TemporalUnit

Doc from java.time.temporal.Temporal.minus.

the unit of the amount to subtract, not null

Returns:PaxDate

Doc from java.time.temporal.Temporal.minus.

an object of the same type with the specified period subtracted, not null

Annotations

@Override

Obtains the current PaxDate from the system clock in the default time-zone.

This will query the system clock in the default time-zone to obtain the current date.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Returns:PaxDate

the current date using the system clock and default time-zone, not null

Obtains the current PaxDate from the system clock in the specified time-zone.

This will query the system clock to obtain the current date. Specifying the time-zone avoids dependence on the default time-zone.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Parameters

zone:ZoneId

the zone ID to use, not null

Returns:PaxDate

the current date using the system clock, not null

Obtains the current PaxDate from the specified clock.

This will query the specified clock to obtain the current date - today. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

Parameters

clock:Clock

the clock to use, not null

Returns:PaxDate

the current date, not null

Exceptions

DateTimeException:

if the current date cannot be obtained

Obtains a PaxDate representing a date in the Pax calendar system from the proleptic-year, month-of-year and day-of-month fields.

This returns a PaxDate with the specified fields. The day must be valid for the year and month, otherwise an exception will be thrown.

Parameters

prolepticYear:int

the Pax proleptic-year

month:int

the Pax month-of-year, from 1 to 14

dayOfMonth:int

the Pax day-of-month, from 1 to 28

Returns:PaxDate

the date in Pax calendar system, not null

Exceptions

DateTimeException:

if the value of any field is out of range, or if the day-of-month is invalid for the month-year

Overrides default java.time.chrono.ChronoLocalDate.plus.

Doc from java.time.chrono.ChronoLocalDate.plus.

Returns an object of the same type as this object with an amount added.

This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a java.time.Period but may be any other type implementing the TemporalAmount interface, such as java.time.Duration.

Some example code indicating how and why this method is used:

 date = date.plus(period);                // add a Period instance
 date = date.plus(duration);              // add a Duration instance
 date = date.plus(workingDays(6));        // example user-written workingDays method

Note that calling plus followed by minus is not guaranteed to return the same date-time.

Parameters

amount:TemporalAmount

Doc from java.time.temporal.Temporal.plus.

the amount to add, not null

Returns:PaxDate

Doc from java.time.temporal.Temporal.plus.

an object of the same type with the specified adjustment made, not null

Annotations

@Override

Overrides org.threeten.extra.chrono.AbstractDate.plus.

Overrides default java.time.chrono.ChronoLocalDate.plus.

Doc from java.time.chrono.ChronoLocalDate.plus.

Returns an object of the same type as this object with the specified period added.

This method returns a new object based on this one with the specified period added. For example, on a LocalDate, this could be used to add a number of years, months or days. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

Parameters

amountToAdd:long

Doc from java.time.temporal.Temporal.plus.

the amount of the specified unit to add, may be negative

unit:TemporalUnit

Doc from java.time.temporal.Temporal.plus.

the unit of the amount to add, not null

Returns:PaxDate

Doc from java.time.temporal.Temporal.plus.

an object of the same type with the specified period added, not null

Annotations

@Override

Overrides org.threeten.extra.chrono.AbstractDate.range.

Overrides default java.time.temporal.TemporalAccessor.range.

Doc from java.time.temporal.TemporalAccessor.range.

Gets the range of valid values for the specified field.

All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value. The value of this temporal object is used to enhance the accuracy of the returned range. If the date-time cannot return the range, because the field is unsupported or for some other reason, an exception will be thrown.

Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.

Parameters

field:TemporalField

the field to query the range for, not null

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

Overrides default java.time.chrono.ChronoLocalDate.toEpochDay.

Doc from java.time.chrono.ChronoLocalDate.toEpochDay.

Converts this date to the Epoch Day.

The Epoch Day count is a simple incrementing count of days where day 0 is 1970-01-01 (ISO). This definition is the same for all chronologies, enabling conversion.

This default implementation queries the EPOCH_DAY field.

Returns:long

the Epoch Day equivalent to this date

Annotations

@Override

Implements java.time.chrono.ChronoLocalDate.until.

Doc from java.time.chrono.ChronoLocalDate.until.

Calculates the amount of time until another date in terms of the specified unit.

This calculates the amount of time between two ChronoLocalDate objects in terms of a single TemporalUnit. The start and end points are this and the specified date. The result will be negative if the end is before the start. The Temporal passed to this method is converted to a ChronoLocalDate using Chronology#date(TemporalAccessor). The calculation returns a whole number, representing the number of complete units between the two dates. For example, the amount in days between two dates can be calculated using startDate.until(endDate, DAYS).

There are two equivalent ways of using this method. The first is to invoke this method. The second is to use TemporalUnit#between(Temporal, Temporal):

  // these two lines are equivalent
  amount = start.until(end, MONTHS);
  amount = MONTHS.between(start, end);

The calculation is implemented in this method for ChronoUnit. The units DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA and ERAS should be supported by all implementations. Other ChronoUnit values will throw an exception.

If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the converted input temporal as the second argument.

This instance is immutable and unaffected by this method call.

Parameters

endExclusive:Temporal

the end date, exclusive, which is converted to a ChronoLocalDate in the same chronology, not null

unit:TemporalUnit

the unit to measure the amount in, not null

Returns:long

the amount of time between this date and the end date

Annotations

@Override

Implements java.time.chrono.ChronoLocalDate.until.

Doc from java.time.chrono.ChronoLocalDate.until.

Calculates the period between this date and another date as a ChronoPeriod.

This calculates the period between two dates. All supplied chronologies calculate the period using years, months and days, however the ChronoPeriod API allows the period to be represented using other units.

The start and end points are this and the specified date. The result will be negative if the end is before the start. The negative sign will be the same in each of year, month and day.

The calculation is performed using the chronology of this date. If necessary, the input date will be converted to match.

This instance is immutable and unaffected by this method call.

Parameters

endDateExclusive:ChronoLocalDate

the end date, exclusive, which may be in any chronology, not null

Returns:ChronoPeriod

the period between this date and the end date, not null

Annotations

@Override

Overrides default java.time.chrono.ChronoLocalDate.with.

Doc from java.time.chrono.ChronoLocalDate.with.

Returns an adjusted object of the same type as this object with the adjustment made.

This adjusts this date-time according to the rules of the specified adjuster. A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month. A selection of common adjustments is provided in TemporalAdjusters. These include finding the "last day of the month" and "next Wednesday". The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.

Some example code indicating how and why this method is used:

 date = date.with(Month.JULY);        // most key classes implement TemporalAdjuster
 date = date.with(lastDayOfMonth());  // static import from Adjusters
 date = date.with(next(WEDNESDAY));   // static import from Adjusters and DayOfWeek

Parameters

adjuster:TemporalAdjuster

Doc from java.time.temporal.Temporal.with.

the adjuster to use, not null

Returns:PaxDate

Doc from java.time.temporal.Temporal.with.

an object of the same type with the specified adjustment made, not null

Annotations

@Override

Overrides org.threeten.extra.chrono.AbstractDate.with.

Overrides default java.time.chrono.ChronoLocalDate.with.

Doc from java.time.chrono.ChronoLocalDate.with.

Returns an object of the same type as this object with the specified field altered.

This returns a new object based on this one with the value for the specified field changed. For example, on a LocalDate, this could be used to set the year, month or day-of-month. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

Parameters

field:TemporalField

Doc from java.time.temporal.Temporal.with.

the field to set in the result, not null

newValue:long

Doc from java.time.temporal.Temporal.with.

the new value of the field in the result

Returns:PaxDate

Doc from java.time.temporal.Temporal.with.

an object of the same type with the specified field set, not null

Annotations

@Override