Serializable
, Comparable<ChronoLocalDate>
, ChronoLocalDate
, Temporal
, TemporalAccessor
, TemporalAdjuster
public final class MinguoDate extends Object implements ChronoLocalDate, Serializable
This date operates using the Minguo calendar. This calendar system is primarily used in the Republic of China, often known as Taiwan. Dates are aligned such that 0001-01-01 (Minguo)
is 1912-01-01 (ISO)
.
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.
Modifier and Type | Method | Description |
---|---|---|
final ChronoLocalDateTime |
atTime |
Combines this date with a time to create a ChronoLocalDateTime . |
boolean |
equals |
Compares this date to another date, including the chronology. |
static MinguoDate |
from |
Obtains a MinguoDate from a temporal object. |
MinguoChronology |
getChronology() |
Gets the chronology of this date, which is the Minguo calendar system. |
MinguoEra |
getEra() |
Gets the era applicable at this date. |
long |
getLong |
Gets the value of the specified field as a long . |
int |
hashCode() |
A hash code for this date. |
int |
lengthOfMonth() |
Returns the length of the month represented by this date. |
MinguoDate |
minus |
Returns an object of the same type as this object with the specified period subtracted. |
MinguoDate |
minus |
Returns an object of the same type as this object with an amount subtracted. |
static MinguoDate |
now() |
Obtains the current MinguoDate from the system clock in the default time-zone. |
static MinguoDate |
now |
Obtains the current MinguoDate from the specified clock. |
static MinguoDate |
now |
Obtains the current MinguoDate from the system clock in the specified time-zone. |
static MinguoDate |
of |
Obtains a MinguoDate representing a date in the Minguo calendar system from the proleptic-year, month-of-year and day-of-month fields. |
MinguoDate |
plus |
Returns an object of the same type as this object with the specified period added. |
MinguoDate |
plus |
Returns an object of the same type as this object with an amount added. |
String |
toString() |
Returns a string representation of the object. |
ChronoPeriod |
until |
Calculates the period between this date and another date as a ChronoPeriod . |
long |
until |
Calculates the amount of time until another date in terms of the specified unit. |
MinguoDate |
with |
Returns an adjusted object of the same type as this object with the adjustment made. |
MinguoDate |
with |
Returns an object of the same type as this object with the specified field altered. |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
adjustInto, compareTo, format, isAfter, isBefore, isEqual, isLeapYear, isSupported, isSupported, lengthOfYear, query, toEpochDay, toString, until
get, range
public static MinguoDate now()
MinguoDate
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.
public static MinguoDate now(ZoneId zone)
MinguoDate
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.
zone
- the zone ID to use, not nullpublic static MinguoDate now(Clock clock)
MinguoDate
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.
clock
- the clock to use, not nullDateTimeException
- if the current date cannot be obtainedpublic static MinguoDate of(int prolepticYear, int month, int dayOfMonth)
MinguoDate
representing a date in the Minguo calendar system from the proleptic-year, month-of-year and day-of-month fields. This returns a MinguoDate
with the specified fields. The day must be valid for the year and month, otherwise an exception will be thrown.
prolepticYear
- the Minguo proleptic-yearmonth
- the Minguo month-of-year, from 1 to 12dayOfMonth
- the Minguo day-of-month, from 1 to 31DateTimeException
- if the value of any field is out of range, or if the day-of-month is invalid for the month-yearpublic static MinguoDate from(TemporalAccessor temporal)
MinguoDate
from a temporal object. This obtains a date in the Minguo 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 MinguoDate
.
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, MinguoDate::from
.
temporal
- the temporal object to convert, not nullDateTimeException
- if unable to convert to a MinguoDate
public MinguoChronology getChronology()
The Chronology
represents the calendar system in use. The era and other fields in ChronoField
are defined by the chronology.
getChronology
in interface ChronoLocalDate
public MinguoEra getEra()
The Minguo calendar system has two eras, 'ROC' and 'BEFORE_ROC', defined by MinguoEra
.
getEra
in interface ChronoLocalDate
public int lengthOfMonth()
This returns the length of the month in days. Month lengths match those of the ISO calendar system.
lengthOfMonth
in interface ChronoLocalDate
public long getLong(TemporalField field)
TemporalAccessor
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.
getLong
in interface TemporalAccessor
field
- the field to get, not nullpublic MinguoDate with(TemporalField field, long newValue)
ChronoLocalDate
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.
with
in interface ChronoLocalDate
with
in interface Temporal
field
- the field to set in the result, not nullnewValue
- the new value of the field in the resultpublic MinguoDate with(TemporalAdjuster adjuster)
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
with
in interface ChronoLocalDate
with
in interface Temporal
adjuster
- the adjuster to use, not nullDateTimeException
- if unable to make the adjustmentArithmeticException
- if numeric overflow occurspublic MinguoDate plus(TemporalAmount amount)
This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a Period
but may be any other type implementing the TemporalAmount
interface, such as 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.
plus
in interface ChronoLocalDate
plus
in interface Temporal
amount
- the amount to add, not nullDateTimeException
- if the addition cannot be madeArithmeticException
- if numeric overflow occurspublic MinguoDate minus(TemporalAmount amount)
This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a Period
but may be any other type implementing the TemporalAmount
interface, such as 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.
minus
in interface ChronoLocalDate
minus
in interface Temporal
amount
- the amount to subtract, not nullDateTimeException
- if the subtraction cannot be madeArithmeticException
- if numeric overflow occurspublic MinguoDate plus(long amountToAdd, TemporalUnit unit)
ChronoLocalDate
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.
plus
in interface ChronoLocalDate
plus
in interface Temporal
amountToAdd
- the amount of the specified unit to add, may be negativeunit
- the unit of the amount to add, not nullpublic MinguoDate minus(long amountToSubtract, TemporalUnit unit)
ChronoLocalDate
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.
minus
in interface ChronoLocalDate
minus
in interface Temporal
amountToSubtract
- the amount of the specified unit to subtract, may be negativeunit
- the unit of the amount to subtract, not nullpublic final ChronoLocalDateTime<MinguoDate> atTime(LocalTime localTime)
ChronoLocalDate
ChronoLocalDateTime
. This returns a ChronoLocalDateTime
formed from this date at the specified time. All possible combinations of date and time are valid.
atTime
in interface ChronoLocalDate
localTime
- the local time to use, not nullpublic ChronoPeriod until(ChronoLocalDate endDate)
ChronoLocalDate
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.
until
in interface ChronoLocalDate
endDate
- the end date, exclusive, which may be in any chronology, not nullpublic boolean equals(Object obj)
Compares this MinguoDate
with another ensuring that the date is the same.
Only objects of type MinguoDate
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.
equals
in interface ChronoLocalDate
obj
- the object to check, null returns falsepublic int hashCode()
hashCode
in interface ChronoLocalDate
public long until(Temporal endExclusive, TemporalUnit unit)
ChronoLocalDate
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 choice should be made based on which makes the code more readable.
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.
until
in interface ChronoLocalDate
until
in interface Temporal
endExclusive
- the end date, exclusive, which is converted to a ChronoLocalDate
in the same chronology, not nullunit
- the unit to measure the amount in, not nullpublic String toString()
Object
toString
in interface ChronoLocalDate
toString
in class Object
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/chrono/MinguoDate.html