- All Implemented Interfaces:
Serializable,Comparable<ChronoLocalDate>,ChronoLocalDate,Temporal,TemporalAccessor,TemporalAdjuster
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.
- Implementation Requirements:
- This class is immutable and thread-safe.
- Since:
- 1.8
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionfinal ChronoLocalDateTime<MinguoDate> Combines this date with a time to create aChronoLocalDateTime.booleanCompares this date to another date, including the chronology.static MinguoDatefrom(TemporalAccessor temporal) Obtains aMinguoDatefrom a temporal object.Gets the chronology of this date, which is the Minguo calendar system.getEra()Gets the era applicable at this date.longgetLong(TemporalField field) Gets the value of the specified field as along.inthashCode()A hash code for this date.intReturns the length of the month represented by this date.minus(long amountToSubtract, TemporalUnit unit) Returns an object of the same type as this object with the specified period subtracted.minus(TemporalAmount amount) Returns an object of the same type as this object with an amount subtracted.static MinguoDatenow()Obtains the currentMinguoDatefrom the system clock in the default time-zone.static MinguoDateObtains the currentMinguoDatefrom the specified clock.static MinguoDateObtains the currentMinguoDatefrom the system clock in the specified time-zone.static MinguoDateof(int prolepticYear, int month, int dayOfMonth) Obtains aMinguoDaterepresenting a date in the Minguo calendar system from the proleptic-year, month-of-year and day-of-month fields.plus(long amountToAdd, TemporalUnit unit) Returns an object of the same type as this object with the specified period added.plus(TemporalAmount amount) Returns an object of the same type as this object with an amount added.toString()Returns a string representation of the object.until(ChronoLocalDate endDate) Calculates the period between this date and another date as aChronoPeriod.longuntil(Temporal endExclusive, TemporalUnit unit) Calculates the amount of time until another date in terms of the specified unit.with(TemporalAdjuster adjuster) Returns an adjusted object of the same type as this object with the adjustment made.with(TemporalField field, long newValue) Returns an object of the same type as this object with the specified field altered.Methods declared in class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods declared in interface java.time.chrono.ChronoLocalDate
adjustInto, compareTo, format, isAfter, isBefore, isEqual, isLeapYear, isSupported, isSupported, lengthOfYear, query, toEpochDay, toString, untilMethods declared in interface java.time.temporal.TemporalAccessor
get, range
-
Method Details
-
now
Obtains the currentMinguoDatefrom 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
Obtains the currentMinguoDatefrom 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
Obtains the currentMinguoDatefrom 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
Obtains aMinguoDaterepresenting a date in the Minguo calendar system from the proleptic-year, month-of-year and day-of-month fields.This returns a
MinguoDatewith the specified fields. The day must be valid for the year and month, otherwise an exception will be thrown.- Parameters:
prolepticYear- the Minguo proleptic-yearmonth- the Minguo month-of-year, from 1 to 12dayOfMonth- the Minguo day-of-month, from 1 to 31- Returns:
- the date in Minguo 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
Obtains aMinguoDatefrom a temporal object.This obtains a date in the Minguo calendar system based on the specified temporal. A
TemporalAccessorrepresents an arbitrary set of date and time information, which this factory converts to an instance ofMinguoDate.The conversion typically 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,MinguoDate::from.- Parameters:
temporal- the temporal object to convert, not null- Returns:
- the date in Minguo calendar system, not null
- Throws:
DateTimeException- if unable to convert to aMinguoDate
-
getChronology
Gets the chronology of this date, which is the Minguo 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 Minguo chronology, not null
-
getEra
Gets the era applicable at this date.The Minguo calendar system has two eras, 'ROC' and 'BEFORE_ROC', defined by
MinguoEra.- 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. Month lengths match those of the ISO calendar system.
- Specified by:
lengthOfMonthin interfaceChronoLocalDate- Returns:
- the length of the month in days
-
getLong
Description copied from interface:TemporalAccessorGets the value of the specified field as along.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.
- Specified by:
getLongin interfaceTemporalAccessor- Parameters:
field- the field to get, not null- Returns:
- the value for the field
-
with
Description copied from interface:ChronoLocalDateReturns 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.
- Specified by:
within interfaceChronoLocalDate- Specified by:
within interfaceTemporal- Parameters:
field- the field to set in the result, not nullnewValue- the new value of the field in the result- Returns:
- an object of the same type with the specified field set, not null
-
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
- Specified by:
within interfaceChronoLocalDate- Specified by:
within interfaceTemporal- Parameters:
adjuster- the adjuster to use, not null- Returns:
- an object of the same type with the specified adjustment made, not null
- Throws:
DateTimeException- if unable to make the adjustmentArithmeticException- if numeric overflow occurs
-
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
Periodbut may be any other type implementing theTemporalAmountinterface, such asDuration.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
plusfollowed byminusis not guaranteed to return the same date-time.- Specified by:
plusin interfaceChronoLocalDate- Specified by:
plusin interfaceTemporal- Parameters:
amount- the amount to add, not null- Returns:
- an object of the same type with the specified adjustment made, not null
- Throws:
DateTimeException- if the addition cannot be madeArithmeticException- if numeric overflow occurs
-
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
Periodbut may be any other type implementing theTemporalAmountinterface, such asDuration.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
plusfollowed byminusis not guaranteed to return the same date-time.- Specified by:
minusin interfaceChronoLocalDate- Specified by:
minusin interfaceTemporal- Parameters:
amount- the amount to subtract, not null- Returns:
- an object of the same type with the specified adjustment made, not null
- Throws:
DateTimeException- if the subtraction cannot be madeArithmeticException- if numeric overflow occurs
-
plus
Description copied from interface:ChronoLocalDateReturns 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.
- Specified by:
plusin interfaceChronoLocalDate- Specified by:
plusin interfaceTemporal- Parameters:
amountToAdd- the amount of the specified unit to add, may be negativeunit- the unit of the amount to add, not null- Returns:
- an object of the same type with the specified period added, not null
-
minus
Description copied from interface:ChronoLocalDateReturns 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.
- Specified by:
minusin interfaceChronoLocalDate- Specified by:
minusin interfaceTemporal- Parameters:
amountToSubtract- the amount of the specified unit to subtract, may be negativeunit- the unit of the amount to subtract, not null- Returns:
- an object of the same type with the specified period subtracted, not null
-
atTime
Description copied from interface:ChronoLocalDateCombines this date with a time to create aChronoLocalDateTime.This returns a
ChronoLocalDateTimeformed from this date at the specified time. All possible combinations of date and time are valid.- Specified by:
atTimein interfaceChronoLocalDate- Parameters:
localTime- the local time to use, not null- Returns:
- the local date-time formed from this date and the specified time, not null
-
until
Description copied from interface:ChronoLocalDateCalculates the period between this date and another date as aChronoPeriod.This calculates the period between two dates. All supplied chronologies calculate the period using years, months and days, however the
ChronoPeriodAPI allows the period to be represented using other units.The start and end points are
thisand 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.
- Specified by:
untilin interfaceChronoLocalDate- Parameters:
endDate- the end date, exclusive, which may be in any chronology, not null- Returns:
- the period between this date and the end date, not null
-
equals
Compares this date to another date, including the chronology.Compares this
MinguoDatewith another ensuring that the date is the same.Only objects of type
MinguoDateare compared, other types return false. To compare the dates of twoTemporalAccessorinstances, 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
- See Also:
-
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
- See Also:
-
until
Description copied from interface:ChronoLocalDateCalculates the amount of time until another date in terms of the specified unit.This calculates the amount of time between two
ChronoLocalDateobjects in terms of a singleTemporalUnit. The start and end points arethisand the specified date. The result will be negative if the end is before the start. TheTemporalpassed to this method is converted to aChronoLocalDateusingChronology.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 usingstartDate.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 unitsDAYS,WEEKS,MONTHS,YEARS,DECADES,CENTURIES,MILLENNIAandERASshould be supported by all implementations. OtherChronoUnitvalues will throw an exception.If the unit is not a
ChronoUnit, then the result of this method is obtained by invokingTemporalUnit.between(Temporal, Temporal)passingthisas the first argument and the converted input temporal as the second argument.This instance is immutable and unaffected by this method call.
- Specified by:
untilin interfaceChronoLocalDate- Specified by:
untilin interfaceTemporal- Parameters:
endExclusive- the end date, exclusive, which is converted to aChronoLocalDatein the same chronology, not nullunit- the unit to measure the amount in, not null- Returns:
- the amount of time between this date and the end date
-
toString
Description copied from class:ObjectReturns a string representation of the object.- Specified by:
toStringin interfaceChronoLocalDate- Overrides:
toStringin classObject- Returns:
- a string representation of the object.
-