- java.lang.Object
-
- org.threeten.extra.chrono.BritishCutoverDate
-
- All Implemented Interfaces:
Serializable,Comparable<ChronoLocalDate>,ChronoLocalDate,Temporal,TemporalAccessor,TemporalAdjuster
public final class BritishCutoverDate extends Object implements ChronoLocalDate, Serializable
A date in the British Cutover calendar system.This date operates using the British Cutover calendar.
Implementation Requirements
This class is immutable and thread-safe.This class must be treated as a value type. Do not synchronize, rely on the identity hash code or use the distinction between equals() and ==.
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ChronoLocalDateTime<BritishCutoverDate>atTime(LocalTime localTime)booleanequals(Object obj)Compares this date to another date, including the chronology.static BritishCutoverDatefrom(TemporalAccessor temporal)Obtains aBritishCutoverDatefrom a temporal object.BritishCutoverChronologygetChronology()Gets the chronology of this date, which is the British Cutover calendar system.JulianEragetEra()Gets the era applicable at this date.longgetLong(TemporalField field)inthashCode()A hash code for this date.intlengthOfMonth()Returns the length of the month represented by this date.intlengthOfYear()Returns the length of the year represented by this date.BritishCutoverDateminus(long amountToSubtract, TemporalUnit unit)BritishCutoverDateminus(TemporalAmount amount)static BritishCutoverDatenow()Obtains the currentBritishCutoverDatefrom the system clock in the default time-zone.static BritishCutoverDatenow(Clock clock)Obtains the currentBritishCutoverDatefrom the specified clock.static BritishCutoverDatenow(ZoneId zone)Obtains the currentBritishCutoverDatefrom the system clock in the specified time-zone.static BritishCutoverDateof(int prolepticYear, int month, int dayOfMonth)Obtains aBritishCutoverDaterepresenting a date in the British Cutover calendar system from the proleptic-year, month-of-year and day-of-month fields.BritishCutoverDateplus(long amountToAdd, TemporalUnit unit)BritishCutoverDateplus(TemporalAmount amount)<R> Rquery(TemporalQuery<R> query)ValueRangerange(TemporalField field)ValueRangerangeChrono(ChronoField field)longtoEpochDay()StringtoString()ChronoPerioduntil(ChronoLocalDate endDateExclusive)longuntil(Temporal endExclusive, TemporalUnit unit)BritishCutoverDatewith(TemporalAdjuster adjuster)BritishCutoverDatewith(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.chrono.ChronoLocalDate
adjustInto, compareTo, format, isAfter, isBefore, isEqual, isLeapYear, isSupported, isSupported, toString
-
Methods inherited from interface java.time.temporal.TemporalAccessor
get, getLong, range
-
-
-
-
Method Detail
-
now
public static BritishCutoverDate now()
Obtains the currentBritishCutoverDatefrom the system clock in the default time-zone.This will query the
system clockin 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:
- the current date using the system clock and default time-zone, not null
-
now
public static BritishCutoverDate now(ZoneId zone)
Obtains the currentBritishCutoverDatefrom the system clock in the specified time-zone.This will query the
system clockto 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- the zone ID to use, not null- Returns:
- the current date using the system clock, not null
-
now
public static BritishCutoverDate now(Clock clock)
Obtains the currentBritishCutoverDatefrom 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- the clock to use, not null- Returns:
- the current date, not null
- Throws:
DateTimeException- if the current date cannot be obtained
-
of
public static BritishCutoverDate of(int prolepticYear, int month, int dayOfMonth)
Obtains aBritishCutoverDaterepresenting a date in the British Cutover calendar system from the proleptic-year, month-of-year and day-of-month fields.This returns a
BritishCutoverDatewith the specified fields.Dates in the middle of the cutover gap, such as the 10th September 1752, will not throw an exception. Instead, the date will be treated as a Julian date and converted to an ISO date, with the day of month shifted by 11 days.
Invalid dates, such as September 31st will throw an exception.
- Parameters:
prolepticYear- the British Cutover proleptic-yearmonth- the British Cutover month-of-year, from 1 to 12dayOfMonth- the British Cutover day-of-month, from 1 to 31- Returns:
- the date in British Cutover calendar system, not null
- Throws:
DateTimeException- if the value of any field is out of range, or if the day-of-month is invalid for the month-year
-
from
public static BritishCutoverDate from(TemporalAccessor temporal)
Obtains aBritishCutoverDatefrom a temporal object.This obtains a date in the British Cutover calendar system based on the specified temporal. A
TemporalAccessorrepresents an arbitrary set of date and time information, which this factory converts to an instance ofBritishCutoverDate.The conversion uses the
EPOCH_DAYfield, which is standardized across calendar systems.This method matches the signature of the functional interface
TemporalQueryallowing it to be used as a query via method reference,BritishCutoverDate::from.- Parameters:
temporal- the temporal object to convert, not null- Returns:
- the date in British Cutover calendar system, not null
- Throws:
DateTimeException- if unable to convert to aBritishCutoverDate
-
rangeChrono
public ValueRange rangeChrono(ChronoField field)
-
getChronology
public BritishCutoverChronology getChronology()
Gets the chronology of this date, which is the British Cutover calendar system.The
Chronologyrepresents the calendar system in use. The era and other fields inChronoFieldare defined by the chronology.- Specified by:
getChronologyin interfaceChronoLocalDate- Returns:
- the British Cutover chronology, not null
-
getEra
public JulianEra getEra()
Gets the era applicable at this date.The British Cutover calendar system has two eras, 'AD' and 'BC', defined by
JulianEra.- Specified by:
getErain interfaceChronoLocalDate- Returns:
- the era applicable at this date, not null
-
lengthOfMonth
public int lengthOfMonth()
Returns the length of the month represented by this date.This returns the length of the month in days. This takes into account the cutover, returning 19 in September 1752.
- Specified by:
lengthOfMonthin interfaceChronoLocalDate- Returns:
- the length of the month in days, from 19 to 31
-
lengthOfYear
public int lengthOfYear()
Returns the length of the year represented by this date.This returns the length of the year in days. This takes into account the cutover, returning 355 in 1752.
- Specified by:
lengthOfYearin interfaceChronoLocalDate- Returns:
- the length of the month in days, from 19 to 31
-
with
public BritishCutoverDate with(TemporalAdjuster adjuster)
- Specified by:
within interfaceChronoLocalDate- Specified by:
within interfaceTemporal
-
with
public BritishCutoverDate with(TemporalField field, long newValue)
- Specified by:
within interfaceChronoLocalDate- Specified by:
within interfaceTemporal
-
plus
public BritishCutoverDate plus(TemporalAmount amount)
- Specified by:
plusin interfaceChronoLocalDate- Specified by:
plusin interfaceTemporal
-
plus
public BritishCutoverDate plus(long amountToAdd, TemporalUnit unit)
- Specified by:
plusin interfaceChronoLocalDate- Specified by:
plusin interfaceTemporal
-
minus
public BritishCutoverDate minus(TemporalAmount amount)
- Specified by:
minusin interfaceChronoLocalDate- Specified by:
minusin interfaceTemporal
-
minus
public BritishCutoverDate minus(long amountToSubtract, TemporalUnit unit)
- Specified by:
minusin interfaceChronoLocalDate- Specified by:
minusin interfaceTemporal
-
atTime
public ChronoLocalDateTime<BritishCutoverDate> atTime(LocalTime localTime)
- Specified by:
atTimein interfaceChronoLocalDate
-
until
public long until(Temporal endExclusive, TemporalUnit unit)
- Specified by:
untilin interfaceChronoLocalDate- Specified by:
untilin interfaceTemporal
-
until
public ChronoPeriod until(ChronoLocalDate endDateExclusive)
- Specified by:
untilin interfaceChronoLocalDate
-
toEpochDay
public long toEpochDay()
- Specified by:
toEpochDayin interfaceChronoLocalDate
-
query
public <R> R query(TemporalQuery<R> query)
- Specified by:
queryin interfaceChronoLocalDate- Specified by:
queryin interfaceTemporalAccessor
-
equals
public boolean equals(Object obj)
Compares this date to another date, including the chronology.Compares this date with another ensuring that the date is the same.
Only objects of this concrete type are compared, other types return false. To compare the dates of two
TemporalAccessorinstances, including dates in two different chronologies, useChronoField.EPOCH_DAYas a comparator.- Specified by:
equalsin interfaceChronoLocalDate- Parameters:
obj- the object to check, null returns false- Returns:
- true if this is equal to the other date
-
hashCode
public int hashCode()
A hash code for this date.- Specified by:
hashCodein interfaceChronoLocalDate- Returns:
- a suitable hash code based only on the Chronology and the date
-
range
public ValueRange range(TemporalField field)
- Specified by:
rangein interfaceTemporalAccessor
-
getLong
public long getLong(TemporalField field)
- Specified by:
getLongin interfaceTemporalAccessor
-
toString
public String toString()
- Specified by:
toStringin interfaceChronoLocalDate- Overrides:
toStringin classObject
-
-