Spec-Zone .ru
спецификации, руководства, описания, API
|
public final class JapaneseDate extends Object implements ChronoLocalDate<JapaneseDate>, Serializable
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.
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
.
Modifier and Type | Method and Description |
---|---|
ChronoLocalDateTime<JapaneseDate> |
atTime(LocalTime localTime)
Combines this date with a time to create a
ChronoLocalDateTime . |
boolean |
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
static JapaneseDate |
from(TemporalAccessor temporal)
Obtains a
JapaneseDate from a temporal object. |
JapaneseChronology |
getChronology()
Gets the chronology of this date, which is the Japanese calendar system.
|
JapaneseEra |
getEra()
Gets the era applicable at this date.
|
long |
getLong(TemporalField field)
Gets the value of the specified field as a
long . |
int |
hashCode()
Returns a hash code value for the object.
|
int |
lengthOfMonth()
Returns the length of the month represented by this date.
|
JapaneseDate |
minus(long amountToAdd,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period subtracted.
|
JapaneseDate |
minus(TemporalAmount amount)
Returns an object of the same type as this object with an amount subtracted.
|
static JapaneseDate |
now()
Obtains the current
JapaneseDate from the system clock in the default time-zone. |
static JapaneseDate |
now(Clock clock)
Obtains the current
JapaneseDate from the specified clock. |
static JapaneseDate |
now(ZoneId zone)
Obtains the current
JapaneseDate from the system clock in the specified time-zone. |
static JapaneseDate |
of(Era 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. |
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. |
static JapaneseDate |
ofYearDay(int prolepticYear,
int dayOfYear)
Obtains a
JapaneseDate representing a date in the Japanese calendar
system from the proleptic-year and day-of-year fields. |
Period |
periodUntil(ChronoLocalDate<?> endDate)
Calculates the period between this date and another date as a
Period . |
long |
periodUntil(Temporal endDateTime,
TemporalUnit unit)
Calculates the amount of time until another date in terms of the specified unit.
|
JapaneseDate |
plus(long amountToAdd,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period added.
|
JapaneseDate |
plus(TemporalAmount amount)
Returns an object of the same type as this object with an amount added.
|
ValueRange |
range(TemporalField field)
Gets the range of valid values for the specified field.
|
long |
toEpochDay()
Converts this date to the Epoch Day.
|
String |
toString()
Returns a string representation of the object.
|
JapaneseDate |
with(TemporalAdjuster adjuster)
Returns an adjusted object of the same type as this object with the adjustment made.
|
JapaneseDate |
with(TemporalField field,
long newValue)
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, lengthOfYear, periodUntil, query, timeLineOrder
get
dayOfWeekInMonth, firstDayOfMonth, firstDayOfNextMonth, firstDayOfNextYear, firstDayOfYear, firstInMonth, lastDayOfMonth, lastDayOfYear, lastInMonth, next, nextOrSame, ofDateAdjuster, previous, previousOrSame
public static JapaneseDate now()
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.
public static JapaneseDate now(ZoneId zone)
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.
zone
- the zone ID to use, not nullpublic static JapaneseDate now(Clock clock)
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.
clock
- the clock to use, not nullDateTimeException
- if the current date cannot be obtainedpublic static JapaneseDate of(Era era, int yearOfEra, int month, int dayOfMonth)
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.
era
- the Japanese era, not nullyearOfEra
- the Japanese year-of-eramonth
- the Japanese month-of-year, from 1 to 12dayOfMonth
- the Japanese 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-year,
or if the date is not a Japanese erapublic static JapaneseDate of(int prolepticYear, int month, int dayOfMonth)
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.
prolepticYear
- the Japanese proleptic-yearmonth
- the Japanese month-of-year, from 1 to 12dayOfMonth
- the Japanese 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 JapaneseDate ofYearDay(int prolepticYear, int dayOfYear)
JapaneseDate
representing a date in the Japanese calendar
system from the proleptic-year 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.
prolepticYear
- the chronology proleptic-yeardayOfYear
- the chronology day-of-year, from 1 to 366DateTimeException
- if the value of any field is out of range,
or if the day-of-year is invalid for the yearpublic static JapaneseDate from(TemporalAccessor temporal)
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
.
from
in interface ChronoLocalDate<JapaneseDate>
temporal
- the temporal object to convert, not nullDateTimeException
- if unable to convert to a JapaneseDate
Chronology.date(TemporalAccessor)
public JapaneseChronology 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<JapaneseDate>
public JapaneseEra getEra()
The Japanese calendar system has multiple eras defined by JapaneseEra
.
getEra
in interface ChronoLocalDate<JapaneseDate>
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<JapaneseDate>
public ValueRange range(TemporalField field)
TemporalAccessor
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.
range
in interface TemporalAccessor
field
- the field to query the range for, not nullpublic long getLong(TemporalField field)
TemporalAccessor
long
.
This queries the date-time for the value for 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 JapaneseDate 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<JapaneseDate>
with
in interface Temporal
field
- the field to set in the result, not nullnewValue
- the new value of the field in the resultpublic JapaneseDate 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 TemporalAdjuster
.
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<JapaneseDate>
with
in interface Temporal
adjuster
- the adjuster to use, not nullDateTimeException
- if unable to make the adjustmentArithmeticException
- if numeric overflow occurspublic JapaneseDate 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<JapaneseDate>
plus
in interface Temporal
amount
- the amount to add, not nullDateTimeException
- if the addition cannot be madeArithmeticException
- if numeric overflow occurspublic JapaneseDate 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<JapaneseDate>
minus
in interface Temporal
amount
- the amount to subtract, not nullDateTimeException
- if the subtraction cannot be madeArithmeticException
- if numeric overflow occurspublic JapaneseDate 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<JapaneseDate>
plus
in interface Temporal
amountToAdd
- the amount of the specified unit to add, may be negativeunit
- the unit of the period to add, not nullpublic JapaneseDate minus(long amountToAdd, 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<JapaneseDate>
minus
in interface Temporal
amountToAdd
- the amount of the specified unit to subtract, may be negativeunit
- the unit of the period to subtract, not nullpublic final ChronoLocalDateTime<JapaneseDate> 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<JapaneseDate>
localTime
- the local time to use, not nullpublic Period periodUntil(ChronoLocalDate<?> endDate)
ChronoLocalDate
Period
.
This calculates the period between two dates in terms of years, months and days.
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.
periodUntil
in interface ChronoLocalDate<JapaneseDate>
endDate
- the end date, exclusive, which may be in any chronology, not nullpublic long toEpochDay()
ChronoLocalDate
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.
toEpochDay
in interface ChronoLocalDate<JapaneseDate>
public boolean equals(Object obj)
Object
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y)
consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
equals
in interface ChronoLocalDate<JapaneseDate>
obj
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public int hashCode()
Object
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
hashCode
in interface ChronoLocalDate<JapaneseDate>
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public String toString()
Object
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
toString
in interface ChronoLocalDate<JapaneseDate>
public long periodUntil(Temporal endDateTime, TemporalUnit 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 must be a
ChronoLocalDate
in the same chronology.
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.periodUntil(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.periodUntil(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 input temporal as
the second argument.
This instance is immutable and unaffected by this method call.
periodUntil
in interface ChronoLocalDate<D extends ChronoLocalDate<D>>
periodUntil
in interface Temporal
endDateTime
- the end date, which must be a ChronoLocalDate
in the same chronology, not nullunit
- the unit to measure the amount in, not nullDateTimeException
- if the amount cannot be calculatedArithmeticException
- if numeric overflow occurs
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b92