Top Description Fields Constructors Methods
java.time.chrono

public final Class JapaneseDate

extends ChronoLocalDateImpl<JapaneseDate>
implements ChronoLocalDate, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.time.chrono.ChronoLocalDate, java.lang.Comparable, java.time.temporal.TemporalAdjuster, java.time.temporal.Temporal, java.time.temporal.TemporalAccessor
Annotations
@ValueBased
Static Imports
java.time.temporal.ChronoField.ALIGNED_DAY_OF_WEEK_IN_MONTH, .ChronoField.ALIGNED_DAY_OF_WEEK_IN_YEAR, .ChronoField.ALIGNED_WEEK_OF_MONTH, .ChronoField.ALIGNED_WEEK_OF_YEAR, .ChronoField.DAY_OF_MONTH, .ChronoField.MONTH_OF_YEAR, .ChronoField.YEAR

A date in the Japanese Imperial calendar system.

This date operates using the Japanese Imperial calendar. This calendar system is primarily used in Japan.

The Japanese Imperial calendar system is the same as the ISO calendar system apart from the era-based year numbering. The proleptic-year is defined to be equal to the ISO proleptic-year.

Japan introduced the Gregorian calendar starting with Meiji 6. Only Meiji and later eras are supported; dates before Meiji 6, January 1 are not supported.

For example, the Japanese year "Heisei 24" corresponds to ISO year "2012".
Calling japaneseDate.get(YEAR_OF_ERA) will return 24.
Calling japaneseDate.get(YEAR) will return 2012.
Calling japaneseDate.get(ERA) will return 2, corresponding to JapaneseChronology.ERA_HEISEI.

This is a value-based class; programmers should treat instances that are equal as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail. The equals method should be used for comparisons.

Implementation Specification

This class is immutable and thread-safe.

Since
1.8

Field Summary

Modifier and TypeField and Description
private final transient JapaneseEra
era

The JapaneseEra of this date.

private final transient LocalDate
isoDate

The underlying ISO local date.

pack-priv static final LocalDate
MEIJI_6_ISODATE

The first day supported by the JapaneseChronology is Meiji 6, January 1st.

private static final long
private final transient int
yearOfEra

The Japanese imperial calendar year of this date.

Constructor Summary

AccessConstructor and Description
pack-priv
JapaneseDate(LocalDate
the standard local date, validated not null
isoDate
)

Creates an instance from an ISO date.

pack-priv
JapaneseDate(JapaneseEra
the era, validated not null
era
,
int
the year-of-era, validated
year
,
LocalDate
the standard local date, validated not null
isoDate
)

Constructs a JapaneseDate.

Method Summary

Modifier and TypeMethod and Description
public final ChronoLocalDateTime<JapaneseDate>
atTime(LocalTime
the local time to use, not null
localTime
)

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

Combines this date with a time to create a ChronoLocalDateTime.

public boolean

Returns:

true if this is equal to the other date
equals
(Object
the object to check, null returns false
obj
)

Overrides java.time.chrono.ChronoLocalDateImpl.equals.

Implements java.time.chrono.ChronoLocalDate.equals.

Compares this date to another date, including the chronology.

public static JapaneseDate

Returns:

the date in Japanese calendar system, not null
from
(TemporalAccessor
the temporal object to convert, not null
temporal
)

Hides java.time.chrono.ChronoLocalDate.from.

Obtains a JapaneseDate from a temporal object.

public JapaneseChronology

Returns:

the Japanese chronology, not null
getChronology
()

Implements java.time.chrono.ChronoLocalDate.getChronology.

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

public JapaneseEra

Returns:

the era applicable at this date, not null
getEra
()

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

Gets the era applicable at this date.

public long
getLong(TemporalField
the field to get, not null
field
)

Implements java.time.temporal.TemporalAccessor.getLong.

Gets the value of the specified field as a long.

public int

Returns:

a suitable hash code based only on the Chronology and the date
hashCode
()

Overrides java.time.chrono.ChronoLocalDateImpl.hashCode.

Implements java.time.chrono.ChronoLocalDate.hashCode.

A hash code for this date.

public boolean

Returns:

true if the field is supported on this date, false if not
isSupported
(TemporalField
the field to check, null returns false
field
)

Overrides default java.time.chrono.ChronoLocalDate.isSupported.

Implements java.time.temporal.TemporalAccessor.isSupported.

Checks if the specified field is supported.

public int

Returns:

the length of the month in days
lengthOfMonth
()

Implements java.time.chrono.ChronoLocalDate.lengthOfMonth.

Returns the length of the month represented by this date.

public int
lengthOfYear()

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

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

public JapaneseDate
minus(TemporalAmount
the amount to subtract, not null
amount
)

Overrides java.time.chrono.ChronoLocalDateImpl.minus.

Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.minus.

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

public JapaneseDate
minus(long
the amount of the specified unit to subtract, may be negative
amountToSubtract
,
TemporalUnit
the unit of the amount to subtract, not null
unit
)

Overrides java.time.chrono.ChronoLocalDateImpl.minus.

Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.minus.

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

pack-priv JapaneseDate
minusDays(long
the days to subtract, may be negative
daysToSubtract
)

Overrides java.time.chrono.ChronoLocalDateImpl.minusDays.

Returns a copy of this date with the specified number of days subtracted.

pack-priv JapaneseDate
minusMonths(long
the months to subtract, may be negative
monthsToSubtract
)

Overrides java.time.chrono.ChronoLocalDateImpl.minusMonths.

Returns a copy of this date with the specified number of months subtracted.

pack-priv JapaneseDate
minusWeeks(long
the weeks to subtract, may be negative
weeksToSubtract
)

Overrides java.time.chrono.ChronoLocalDateImpl.minusWeeks.

Returns a copy of this date with the specified number of weeks subtracted.

pack-priv JapaneseDate
minusYears(long
the years to subtract, may be negative
yearsToSubtract
)

Overrides java.time.chrono.ChronoLocalDateImpl.minusYears.

Returns a copy of this date with the specified number of years subtracted.

public static JapaneseDate

Returns:

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

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

public static JapaneseDate

Returns:

the current date using the system clock, not null
now
(ZoneId
the zone ID to use, not null
zone
)

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

public static JapaneseDate

Returns:

the current date, not null
now
(Clock
the clock to use, not null
clock
)

Obtains the current JapaneseDate from the specified clock.

public static JapaneseDate

Returns:

the date in Japanese calendar system, not null
of
(JapaneseEra
the Japanese era, not null
era
,
int
the Japanese year-of-era
yearOfEra
,
int
the Japanese month-of-year, from 1 to 12
month
,
int
the Japanese day-of-month, from 1 to 31
dayOfMonth
)

Obtains a JapaneseDate representing a date in the Japanese calendar system from the era, year-of-era, month-of-year and day-of-month fields.

public static JapaneseDate

Returns:

the date in Japanese calendar system, not null
of
(int
the Japanese proleptic-year
prolepticYear
,
int
the Japanese month-of-year, from 1 to 12
month
,
int
the Japanese day-of-month, from 1 to 31
dayOfMonth
)

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

pack-priv static JapaneseDate

Returns:

the date in Japanese calendar system, not null
ofYearDay
(JapaneseEra
the Japanese era, not null
era
,
int
the Japanese year-of-era
yearOfEra
,
int
the chronology day-of-year, from 1 to 366
dayOfYear
)

Obtains a JapaneseDate representing a date in the Japanese calendar system from the era, year-of-era and day-of-year fields.

public JapaneseDate
plus(TemporalAmount
the amount to add, not null
amount
)

Overrides java.time.chrono.ChronoLocalDateImpl.plus.

Overrides default java.time.chrono.ChronoLocalDate.plus, java.time.temporal.Temporal.plus.

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

public JapaneseDate
plus(long
the amount of the specified unit to add, may be negative
amountToAdd
,
TemporalUnit
the unit of the amount to add, not null
unit
)

Overrides java.time.chrono.ChronoLocalDateImpl.plus.

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

Implements java.time.temporal.Temporal.plus.

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

pack-priv JapaneseDate
plusDays(long
the days to add, may be negative
days
)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusDays.

Returns a copy of this date with the specified number of days added.

pack-priv JapaneseDate
plusMonths(long
the months to add, may be negative
months
)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusMonths.

Returns a copy of this date with the specified number of months added.

pack-priv JapaneseDate
plusWeeks(long
the weeks to add, may be negative
weeksToAdd
)

Overrides java.time.chrono.ChronoLocalDateImpl.plusWeeks.

Returns a copy of this date with the specified number of weeks added.

pack-priv JapaneseDate
plusYears(long
the years to add, may be negative
years
)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusYears.

Returns a copy of this date with the specified number of years added.

public ValueRange
range(TemporalField
the field to query the range for, not null
field
)

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

Gets the range of valid values for the specified field.

pack-priv static JapaneseDate
private void
readObject(ObjectInputStream
the stream to read
s
)

Defend against malicious streams.

public long
toEpochDay()

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

Converts this date to the Epoch Day.

private static LocalGregorianCalendar.Date

Returns:

a LocalGregorianCalendar.Date, not null
toPrivateJapaneseDate
(LocalDate
the local date, not null
isoDate
)

Returns a LocalGregorianCalendar.Date converted from the given isoDate.

public ChronoPeriod
until(ChronoLocalDate
the end date, exclusive, which may be in any chronology, not null
endDate
)

Implements java.time.chrono.ChronoLocalDate.until.

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

public JapaneseDate
with(TemporalField
the field to set in the result, not null
field
,
long
the new value of the field in the result
newValue
)

Overrides java.time.chrono.ChronoLocalDateImpl.with.

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

Implements java.time.temporal.Temporal.with.

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

public JapaneseDate
with(TemporalAdjuster
the adjuster to use, not null
adjuster
)

Overrides java.time.chrono.ChronoLocalDateImpl.with.

Overrides default java.time.chrono.ChronoLocalDate.with, java.time.temporal.Temporal.with.

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

private JapaneseDate
with(LocalDate newDate)

private JapaneseDate

Returns:

a JapaneseDate based on this date with the requested year, never null
withYear
(JapaneseEra
the era to set in the result, not null
era
,
int
the year-of-era to set in the returned date
yearOfEra
)

Returns a copy of this date with the year altered.

private JapaneseDate

Returns:

a JapaneseDate based on this date with the requested year-of-era, never null
withYear
(int
the year to set in the returned date
year
)

Returns a copy of this date with the year-of-era altered.

pack-priv void
private Object

Returns:

the instance of Ser, not null
writeReplace
()

Writes the object using a dedicated serialized form.

Inherited from java.time.chrono.ChronoLocalDateImpl:
ensureValidtoStringuntil

Field Detail

eraback to summary
private final transient JapaneseEra era

The JapaneseEra of this date.

isoDateback to summary
private final transient LocalDate isoDate

The underlying ISO local date.

MEIJI_6_ISODATEback to summary
pack-priv static final LocalDate MEIJI_6_ISODATE

The first day supported by the JapaneseChronology is Meiji 6, January 1st.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.time.chrono.ChronoLocalDateImpl.serialVersionUID.

Serialization version.

Annotations
@Serial
yearOfEraback to summary
private final transient int yearOfEra

The Japanese imperial calendar year of this date.

Constructor Detail

JapaneseDateback to summary
pack-priv JapaneseDate(LocalDate isoDate)

Creates an instance from an ISO date.

Parameters
isoDate:LocalDate

the standard local date, validated not null

JapaneseDateback to summary
pack-priv JapaneseDate(JapaneseEra era, int year, LocalDate isoDate)

Constructs a JapaneseDate. This constructor does NOT validate the given parameters, and era and year must agree with isoDate.

Parameters
era:JapaneseEra

the era, validated not null

year:int

the year-of-era, validated

isoDate:LocalDate

the standard local date, validated not null

Method Detail

atTimeback to summary
public final ChronoLocalDateTime<JapaneseDate> atTime(LocalTime localTime)

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<JapaneseDate>

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

Annotations
@Override
@SuppressWarnings:unchecked
equalsback to summary
public boolean equals(Object obj)

Overrides java.time.chrono.ChronoLocalDateImpl.equals.

Implements java.time.chrono.ChronoLocalDate.equals.

Compares this date to another date, including the chronology.

Compares this JapaneseDate with another ensuring that the date is the same.

Only objects of type JapaneseDate are compared, other types return false. To compare the dates of two TemporalAccessor instances, including dates in two different chronologies, use ChronoField#EPOCH_DAY as a comparator.

Parameters
obj:Object

the object to check, null returns false

Returns:boolean

true if this is equal to the other date

Annotations
@Override
fromback to summary
public static JapaneseDate from(TemporalAccessor temporal)

Hides java.time.chrono.ChronoLocalDate.from.

Obtains a JapaneseDate from a temporal object.

This obtains a date in the Japanese 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 JapaneseDate.

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, JapaneseDate::from.

Parameters
temporal:TemporalAccessor

the temporal object to convert, not null

Returns:JapaneseDate

the date in Japanese calendar system, not null

Exceptions
DateTimeException:
if unable to convert to a JapaneseDate
getChronologyback to summary
public JapaneseChronology getChronology()

Implements java.time.chrono.ChronoLocalDate.getChronology.

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

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

Returns:JapaneseChronology

the Japanese chronology, not null

Annotations
@Override
getEraback to summary
public JapaneseEra getEra()

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

Gets the era applicable at this date.

The Japanese calendar system has multiple eras defined by JapaneseEra.

Returns:JapaneseEra

the era applicable at this date, not null

Annotations
@Override
getLongback to summary
public long getLong(TemporalField field)

Implements java.time.temporal.TemporalAccessor.getLong.

Doc from java.time.temporal.TemporalAccessor.getLong.

Gets the value of the specified field as a long.

This queries the date-time for the value of the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.

Parameters
field:TemporalField

the field to get, not null

Returns:long

the value for the field

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.time.chrono.ChronoLocalDateImpl.hashCode.

Implements java.time.chrono.ChronoLocalDate.hashCode.

A hash code for this date.

Returns:int

a suitable hash code based only on the Chronology and the date

Annotations
@Override
isSupportedback to summary
public boolean isSupported(TemporalField field)

Overrides default java.time.chrono.ChronoLocalDate.isSupported.

Implements java.time.temporal.TemporalAccessor.isSupported.

Checks if the specified field is supported.

This checks if this date can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

If the field is a ChronoField then the query is implemented here. The supported fields are:

  • DAY_OF_WEEK
  • DAY_OF_MONTH
  • DAY_OF_YEAR
  • EPOCH_DAY
  • MONTH_OF_YEAR
  • PROLEPTIC_MONTH
  • YEAR_OF_ERA
  • YEAR
  • ERA
All other ChronoField instances will return false.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

Parameters
field:TemporalField

the field to check, null returns false

Returns:boolean

true if the field is supported on this date, false if not

Annotations
@Override
lengthOfMonthback to summary
public int lengthOfMonth()

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 match those of the ISO calendar system.

Returns:int

the length of the month in days

Annotations
@Override
lengthOfYearback to summary
public int lengthOfYear()

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
minusback to summary
public JapaneseDate minus(TemporalAmount amount)

Overrides java.time.chrono.ChronoLocalDateImpl.minus.

Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.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:JapaneseDate

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

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

Annotations
@Override
Exceptions
DateTimeException:
if the subtraction cannot be made
ArithmeticException:
if numeric overflow occurs
minusback to summary
public JapaneseDate minus(long amountToSubtract, TemporalUnit unit)

Overrides java.time.chrono.ChronoLocalDateImpl.minus.

Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.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:JapaneseDate

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

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

Annotations
@Override
minusDaysback to summary
pack-priv JapaneseDate minusDays(long daysToSubtract)

Overrides java.time.chrono.ChronoLocalDateImpl.minusDays.

Doc from java.time.chrono.ChronoLocalDateImpl.minusDays.

Returns a copy of this date with the specified number of days subtracted.

This subtracts the specified period in days to the date.

The default implementation uses plusDays(long).

This instance is immutable and unaffected by this method call.

Parameters
daysToSubtract:long

the days to subtract, may be negative

Returns:JapaneseDate

a date based on this one with the days subtracted, not null

Annotations
@Override
minusMonthsback to summary
pack-priv JapaneseDate minusMonths(long monthsToSubtract)

Overrides java.time.chrono.ChronoLocalDateImpl.minusMonths.

Doc from java.time.chrono.ChronoLocalDateImpl.minusMonths.

Returns a copy of this date with the specified number of months subtracted.

This subtracts the specified period in months to the date. In some cases, subtracting months can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month.

The default implementation uses plusMonths(long).

This instance is immutable and unaffected by this method call.

Parameters
monthsToSubtract:long

the months to subtract, may be negative

Returns:JapaneseDate

a date based on this one with the months subtracted, not null

Annotations
@Override
minusWeeksback to summary
pack-priv JapaneseDate minusWeeks(long weeksToSubtract)

Overrides java.time.chrono.ChronoLocalDateImpl.minusWeeks.

Doc from java.time.chrono.ChronoLocalDateImpl.minusWeeks.

Returns a copy of this date with the specified number of weeks subtracted.

This subtracts the specified period in weeks to the date. In some cases, subtracting weeks can cause the resulting date to become invalid. If this occurs, then other fields will be adjusted to ensure that the result is valid.

The default implementation uses plusWeeks(long).

This instance is immutable and unaffected by this method call.

Parameters
weeksToSubtract:long

the weeks to subtract, may be negative

Returns:JapaneseDate

a date based on this one with the weeks subtracted, not null

Annotations
@Override
minusYearsback to summary
pack-priv JapaneseDate minusYears(long yearsToSubtract)

Overrides java.time.chrono.ChronoLocalDateImpl.minusYears.

Doc from java.time.chrono.ChronoLocalDateImpl.minusYears.

Returns a copy of this date with the specified number of years subtracted.

This subtracts the specified period in years to the date. In some cases, subtracting years can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month.

The default implementation uses plusYears(long).

This instance is immutable and unaffected by this method call.

Parameters
yearsToSubtract:long

the years to subtract, may be negative

Returns:JapaneseDate

a date based on this one with the years subtracted, not null

Annotations
@Override
nowback to summary
public static JapaneseDate now()

Obtains the current JapaneseDate 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:JapaneseDate

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

nowback to summary
public static JapaneseDate now(ZoneId zone)

Obtains the current JapaneseDate 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:JapaneseDate

the current date using the system clock, not null

nowback to summary
public static JapaneseDate now(Clock clock)

Obtains the current JapaneseDate 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:JapaneseDate

the current date, not null

Exceptions
DateTimeException:
if the current date cannot be obtained
ofback to summary
public static JapaneseDate of(JapaneseEra era, int yearOfEra, int month, int dayOfMonth)

Obtains a JapaneseDate representing a date in the Japanese calendar system from the era, year-of-era, month-of-year and day-of-month fields.

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

The Japanese month and day-of-month are the same as those in the ISO calendar system. They are not reset when the era changes. For example:

 6th Jan Showa 64 = ISO 1989-01-06
 7th Jan Showa 64 = ISO 1989-01-07
 8th Jan Heisei 1 = ISO 1989-01-08
 9th Jan Heisei 1 = ISO 1989-01-09
Parameters
era:JapaneseEra

the Japanese era, not null

yearOfEra:int

the Japanese year-of-era

month:int

the Japanese month-of-year, from 1 to 12

dayOfMonth:int

the Japanese day-of-month, from 1 to 31

Returns:JapaneseDate

the date in Japanese 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, or if the date is not a Japanese era
ofback to summary
public static JapaneseDate of(int prolepticYear, int month, int dayOfMonth)

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

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

The Japanese proleptic year, month and day-of-month are the same as those in the ISO calendar system. They are not reset when the era changes.

Parameters
prolepticYear:int

the Japanese proleptic-year

month:int

the Japanese month-of-year, from 1 to 12

dayOfMonth:int

the Japanese day-of-month, from 1 to 31

Returns:JapaneseDate

the date in Japanese 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
ofYearDayback to summary
pack-priv static JapaneseDate ofYearDay(JapaneseEra era, int yearOfEra, int dayOfYear)

Obtains a JapaneseDate representing a date in the Japanese calendar system from the era, year-of-era and day-of-year fields.

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

The day-of-year in this factory is expressed relative to the start of the year-of-era. This definition changes the normal meaning of day-of-year only in those years where the year-of-era is reset to one due to a change in the era. For example:

 6th Jan Showa 64 = day-of-year 6
 7th Jan Showa 64 = day-of-year 7
 8th Jan Heisei 1 = day-of-year 1
 9th Jan Heisei 1 = day-of-year 2
Parameters
era:JapaneseEra

the Japanese era, not null

yearOfEra:int

the Japanese year-of-era

dayOfYear:int

the chronology day-of-year, from 1 to 366

Returns:JapaneseDate

the date in Japanese calendar system, not null

Exceptions
DateTimeException:
if the value of any field is out of range, or if the day-of-year is invalid for the year
plusback to summary
public JapaneseDate plus(TemporalAmount amount)

Overrides java.time.chrono.ChronoLocalDateImpl.plus.

Overrides default java.time.chrono.ChronoLocalDate.plus, java.time.temporal.Temporal.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:JapaneseDate

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

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

Annotations
@Override
Exceptions
DateTimeException:
if the addition cannot be made
ArithmeticException:
if numeric overflow occurs
plusback to summary
public JapaneseDate plus(long amountToAdd, TemporalUnit unit)

Overrides java.time.chrono.ChronoLocalDateImpl.plus.

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

Implements java.time.temporal.Temporal.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:JapaneseDate

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

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

Annotations
@Override
plusDaysback to summary
pack-priv JapaneseDate plusDays(long days)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusDays.

Doc from java.time.chrono.ChronoLocalDateImpl.plusDays.

Returns a copy of this date with the specified number of days added.

This adds the specified period in days to the date.

This instance is immutable and unaffected by this method call.

Parameters
days:long

the days to add, may be negative

Returns:JapaneseDate

a date based on this one with the days added, not null

Annotations
@Override
plusMonthsback to summary
pack-priv JapaneseDate plusMonths(long months)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusMonths.

Doc from java.time.chrono.ChronoLocalDateImpl.plusMonths.

Returns a copy of this date with the specified number of months added.

This adds the specified period in months to the date. In some cases, adding months can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month.

This instance is immutable and unaffected by this method call.

Parameters
months:long

the months to add, may be negative

Returns:JapaneseDate

a date based on this one with the months added, not null

Annotations
@Override
plusWeeksback to summary
pack-priv JapaneseDate plusWeeks(long weeksToAdd)

Overrides java.time.chrono.ChronoLocalDateImpl.plusWeeks.

Doc from java.time.chrono.ChronoLocalDateImpl.plusWeeks.

Returns a copy of this date with the specified number of weeks added.

This adds the specified period in weeks to the date. In some cases, adding weeks can cause the resulting date to become invalid. If this occurs, then other fields will be adjusted to ensure that the result is valid.

The default implementation uses plusDays(long) using a 7 day week.

This instance is immutable and unaffected by this method call.

Parameters
weeksToAdd:long

the weeks to add, may be negative

Returns:JapaneseDate

a date based on this one with the weeks added, not null

Annotations
@Override
plusYearsback to summary
pack-priv JapaneseDate plusYears(long years)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusYears.

Doc from java.time.chrono.ChronoLocalDateImpl.plusYears.

Returns a copy of this date with the specified number of years added.

This adds the specified period in years to the date. In some cases, adding years can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month.

This instance is immutable and unaffected by this method call.

Parameters
years:long

the years to add, may be negative

Returns:JapaneseDate

a date based on this one with the years added, not null

Annotations
@Override
rangeback to summary
public ValueRange range(TemporalField field)

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
readExternalback to summary
pack-priv static JapaneseDate readExternal(DataInput in) throws IOException
readObjectback to summary
private void readObject(ObjectInputStream s) throws InvalidObjectException

Defend against malicious streams.

Parameters
s:ObjectInputStream

the stream to read

Annotations
@Serial
Exceptions
InvalidObjectException:
always
toEpochDayback to summary
public long toEpochDay()

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
toPrivateJapaneseDateback to summary
private static LocalGregorianCalendar.Date toPrivateJapaneseDate(LocalDate isoDate)

Returns a LocalGregorianCalendar.Date converted from the given isoDate.

Parameters
isoDate:LocalDate

the local date, not null

Returns:LocalGregorianCalendar.Date

a LocalGregorianCalendar.Date, not null

untilback to summary
public ChronoPeriod until(ChronoLocalDate endDate)

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
endDate: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
withback to summary
public JapaneseDate with(TemporalField field, long newValue)

Overrides java.time.chrono.ChronoLocalDateImpl.with.

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

Implements java.time.temporal.Temporal.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:JapaneseDate

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

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

Annotations
@Override
withback to summary
public JapaneseDate with(TemporalAdjuster adjuster)

Overrides java.time.chrono.ChronoLocalDateImpl.with.

Overrides default java.time.chrono.ChronoLocalDate.with, java.time.temporal.Temporal.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:JapaneseDate

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

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

Annotations
@Override
Exceptions
DateTimeException:
if unable to make the adjustment
ArithmeticException:
if numeric overflow occurs
withback to summary
private JapaneseDate with(LocalDate newDate)
withYearback to summary
private JapaneseDate withYear(JapaneseEra era, int yearOfEra)

Returns a copy of this date with the year altered.

This method changes the year of the date. If the month-day is invalid for the year, then the previous valid day will be selected instead.

This instance is immutable and unaffected by this method call.

Parameters
era:JapaneseEra

the era to set in the result, not null

yearOfEra:int

the year-of-era to set in the returned date

Returns:JapaneseDate

a JapaneseDate based on this date with the requested year, never null

Exceptions
DateTimeException:
if year is invalid
withYearback to summary
private JapaneseDate withYear(int year)

Returns a copy of this date with the year-of-era altered.

This method changes the year-of-era of the date. If the month-day is invalid for the year, then the previous valid day will be selected instead.

This instance is immutable and unaffected by this method call.

Parameters
year:int

the year to set in the returned date

Returns:JapaneseDate

a JapaneseDate based on this date with the requested year-of-era, never null

Exceptions
DateTimeException:
if year is invalid
writeExternalback to summary
pack-priv void writeExternal(DataOutput out) throws IOException
writeReplaceback to summary
private Object writeReplace()

Writes the object using a dedicated serialized form.

Returns:Object

the instance of Ser, not null

Annotations
@Serial
Serial data
 out.writeByte(4);                 // identifies a JapaneseDate
 out.writeInt(get(YEAR));
 out.writeByte(get(MONTH_OF_YEAR));
 out.writeByte(get(DAY_OF_MONTH));