public final class OffsetDate extends java.lang.Object implements Temporal, TemporalAdjuster, java.lang.Comparable<OffsetDate>, java.io.Serializable
2007-12-03+01:00
.
OffsetDate
is an immutable date-time object that represents a date, often viewed
as year-month-day-offset. This object can also access other date fields such as
day-of-year, day-of-week and week-of-year.
This class does not store or represent a time.
For example, the value "2nd October 2007 +02:00" can be stored
in an OffsetDate
.
Modifier and Type | Field and Description |
---|---|
static OffsetDate |
MAX
The maximum supported
OffsetDate , '+999999999-12-31-18:00'. |
static OffsetDate |
MIN
The minimum supported
OffsetDate , '-999999999-01-01+18:00'. |
Modifier and Type | Method and Description |
---|---|
Temporal |
adjustInto(Temporal temporal)
Adjusts the specified temporal object to have the same offset and date
as this object.
|
OffsetDateTime |
atTime(LocalTime time)
Returns an offset date-time formed from this date at the specified time.
|
int |
compareTo(OffsetDate other)
Compares this
OffsetDate to another date. |
boolean |
equals(java.lang.Object obj)
Checks if this date is equal to another date.
|
static OffsetDate |
from(TemporalAccessor temporal)
Obtains an instance of
OffsetDate from a temporal object. |
int |
get(TemporalField field)
Gets the value of the specified field from this date as an
int . |
LocalDate |
getDate()
Gets the
LocalDate part of this date-time. |
int |
getDayOfMonth()
Gets the day-of-month field.
|
DayOfWeek |
getDayOfWeek()
Gets the day-of-week field, which is an enum
DayOfWeek . |
int |
getDayOfYear()
Gets the day-of-year field.
|
long |
getLong(TemporalField field)
Gets the value of the specified field from this date as a
long . |
Month |
getMonth()
Gets the month-of-year field using the
Month enum. |
int |
getMonthValue()
Gets the month-of-year field from 1 to 12.
|
ZoneOffset |
getOffset()
Gets the zone offset, such as '+01:00'.
|
int |
getYear()
Gets the year field.
|
int |
hashCode()
A hash code for this date.
|
boolean |
isAfter(OffsetDate other)
Checks if the instant of midnight at the start of this
OffsetDate
is after midnight at the start of the specified date. |
boolean |
isBefore(OffsetDate other)
Checks if the instant of midnight at the start of this
OffsetDate
is before midnight at the start of the specified date. |
boolean |
isEqual(OffsetDate other)
Checks if the instant of midnight at the start of this
OffsetDate
equals midnight at the start of the specified date. |
boolean |
isSupported(TemporalField field)
Checks if the specified field is supported.
|
OffsetDate |
minus(long amountToSubtract,
TemporalUnit unit)
Returns a copy of this date with the specified period subtracted.
|
OffsetDate |
minus(TemporalSubtractor subtractor)
Returns a copy of this date with the specified period subtracted.
|
OffsetDate |
minusDays(long days)
Returns a copy of this
OffsetDate with the specified number of days subtracted. |
OffsetDate |
minusMonths(long months)
Returns a copy of this
OffsetDate with the specified period in months subtracted. |
OffsetDate |
minusWeeks(long weeks)
Returns a copy of this
OffsetDate with the specified period in weeks subtracted. |
OffsetDate |
minusYears(long years)
Returns a copy of this
OffsetDate with the specified period in years subtracted. |
static OffsetDate |
now()
Obtains the current date from the system clock in the default time-zone.
|
static OffsetDate |
now(Clock clock)
Obtains the current date from the specified clock.
|
static OffsetDate |
now(ZoneId zone)
Obtains the current date from the system clock in the specified time-zone.
|
static OffsetDate |
of(LocalDate date,
ZoneOffset offset)
Obtains an instance of
OffsetDate from a local date and an offset. |
static OffsetDate |
ofInstant(Instant instant,
ZoneId zone)
Obtains an instance of
OffsetDate from an Instant and zone ID. |
static OffsetDate |
parse(java.lang.CharSequence text)
Obtains an instance of
OffsetDate from a text string such as 2007-12-03+01:00 . |
static OffsetDate |
parse(java.lang.CharSequence text,
DateTimeFormatter formatter)
Obtains an instance of
OffsetDate from a text string using a specific formatter. |
long |
periodUntil(Temporal endDate,
TemporalUnit unit)
Calculates the period between this date and another date in
terms of the specified unit.
|
OffsetDate |
plus(long amountToAdd,
TemporalUnit unit)
Returns a copy of this date with the specified period added.
|
OffsetDate |
plus(TemporalAdder adder)
Returns a copy of this date with the specified period added.
|
OffsetDate |
plusDays(long days)
Returns a copy of this
OffsetDate with the specified period in days added. |
OffsetDate |
plusMonths(long months)
Returns a copy of this
OffsetDate with the specified period in months added. |
OffsetDate |
plusWeeks(long weeks)
Returns a copy of this
OffsetDate with the specified period in weeks added. |
OffsetDate |
plusYears(long years)
Returns a copy of this
OffsetDate with the specified period in years added. |
<R> R |
query(TemporalQuery<R> query)
Queries this date using the specified query.
|
ValueRange |
range(TemporalField field)
Gets the range of valid values for the specified field.
|
java.lang.String |
toString()
Outputs this date as a
String , such as 2007-12-03+01:00 . |
java.lang.String |
toString(DateTimeFormatter formatter)
Outputs this date as a
String using the formatter. |
OffsetDate |
with(TemporalAdjuster adjuster)
Returns an adjusted copy of this date.
|
OffsetDate |
with(TemporalField field,
long newValue)
Returns a copy of this date with the specified field set to a new value.
|
OffsetDate |
withDayOfMonth(int dayOfMonth)
Returns a copy of this
OffsetDate with the day-of-month altered. |
OffsetDate |
withDayOfYear(int dayOfYear)
Returns a copy of this
OffsetDate with the day-of-year altered. |
OffsetDate |
withMonth(int month)
Returns a copy of this
OffsetDate with the month-of-year altered. |
OffsetDate |
withOffset(ZoneOffset offset)
Returns a copy of this
OffsetDate with the specified offset. |
OffsetDate |
withYear(int year)
Returns a copy of this
OffsetDate with the year altered. |
public static final OffsetDate MIN
OffsetDate
, '-999999999-01-01+18:00'.
This is the minimum local date in the maximum offset
(larger offsets are earlier on the time-line).
This combines LocalDate.MIN
and ZoneOffset.MAX
.
This could be used by an application as a "far past" date.public static final OffsetDate MAX
OffsetDate
, '+999999999-12-31-18:00'.
This is the maximum local date in the minimum offset
(larger negative offsets are later on the time-line).
This combines LocalDate.MAX
and ZoneOffset.MIN
.
This could be used by an application as a "far future" date.public static OffsetDate now()
This will query the system clock
in the default
time-zone to obtain the current date.
The offset will be calculated from the time-zone in the clock.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
public static OffsetDate now(ZoneId zone)
This will query the system clock
to obtain the current date.
Specifying the time-zone avoids dependence on the default time-zone.
The offset will be calculated from the specified 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 OffsetDate now(Clock clock)
This will query the specified clock to obtain the current date - today. The offset will be calculated from the time-zone in the clock.
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 nullpublic static OffsetDate of(LocalDate date, ZoneOffset offset)
OffsetDate
from a local date and an offset.date
- the local date, not nulloffset
- the zone offset, not nullpublic static OffsetDate ofInstant(Instant instant, ZoneId zone)
OffsetDate
from an Instant
and zone ID.
This creates an offset date with the same instant as midnight at the start of day of the instant specified. Finding the offset from UTC/Greenwich is simple as there is only one valid offset for each instant.
instant
- the instant to create the time from, not nullzone
- the time-zone, which may be an offset, not nullpublic static OffsetDate from(TemporalAccessor temporal)
OffsetDate
from a temporal object.
A TemporalAccessor
represents some form of date and time information.
This factory converts the arbitrary temporal object to an instance of OffsetDate
.
The conversion extracts and combines LocalDate
and ZoneOffset
.
This method matches the signature of the functional interface TemporalQuery
allowing it to be used in queries via method reference, OffsetDate::from
.
temporal
- the temporal object to convert, not nullDateTimeException
- if unable to convert to an OffsetDate
public static OffsetDate parse(java.lang.CharSequence text)
OffsetDate
from a text string such as 2007-12-03+01:00
.
The string must represent a valid date and is parsed using
DateTimeFormatters.isoOffsetDate()
.
text
- the text to parse such as "2007-12-03+01:00", not nullDateTimeParseException
- if the text cannot be parsedpublic static OffsetDate parse(java.lang.CharSequence text, DateTimeFormatter formatter)
OffsetDate
from a text string using a specific formatter.
The text is parsed using the formatter, returning a date.
text
- the text to parse, not nullformatter
- the formatter to use, not nullDateTimeParseException
- if the text cannot be parsedpublic boolean isSupported(TemporalField field)
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
will return valid
values based on this date-time.
The supported fields are:
DAY_OF_WEEK
ALIGNED_DAY_OF_WEEK_IN_MONTH
ALIGNED_DAY_OF_WEEK_IN_YEAR
DAY_OF_MONTH
DAY_OF_YEAR
EPOCH_DAY
ALIGNED_WEEK_OF_MONTH
ALIGNED_WEEK_OF_YEAR
MONTH_OF_YEAR
EPOCH_MONTH
YEAR_OF_ERA
YEAR
ERA
OFFSET_SECONDS
ChronoField
instances will return false.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doIsSupported(TemporalAccessor)
passing this
as the argument.
Whether the field is supported is determined by the field.
isSupported
in interface TemporalAccessor
field
- the field to check, null returns falsepublic ValueRange range(TemporalField field)
The range object expresses the minimum and maximum valid values for a field. This date is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField
then the query is implemented here.
The supported fields
will return
appropriate range instances.
All other ChronoField
instances will throw a DateTimeException
.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doRange(TemporalAccessor)
passing this
as the argument.
Whether the range can be obtained is determined by the field.
range
in interface TemporalAccessor
field
- the field to query the range for, not nullDateTimeException
- if the range for the field cannot be obtainedpublic int get(TemporalField field)
int
.
This queries this date for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField
then the query is implemented here.
The supported fields
will return valid
values based on this date, except EPOCH_DAY
and EPOCH_MONTH
which are too large to fit in an int
and throw a DateTimeException
.
All other ChronoField
instances will throw a DateTimeException
.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doGet(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
get
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedjava.lang.ArithmeticException
- if numeric overflow occurspublic long getLong(TemporalField field)
long
.
This queries this date for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField
then the query is implemented here.
The supported fields
will return valid
values based on this date.
All other ChronoField
instances will throw a DateTimeException
.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doGet(TemporalAccessor)
passing this
as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
getLong
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedjava.lang.ArithmeticException
- if numeric overflow occurspublic ZoneOffset getOffset()
This is the offset of the local date from UTC/Greenwich.
public OffsetDate withOffset(ZoneOffset offset)
OffsetDate
with the specified offset.
This method returns an object with the same LocalDate
and the specified ZoneOffset
.
No calculation is needed or performed.
For example, if this time represents 2007-12-03+02:00
and the offset specified is
+03:00
, then this method will return 2007-12-03+03:00
.
This instance is immutable and unaffected by this method call.
offset
- the zone offset to change to, not nullOffsetDate
based on this date with the requested offset, not nullpublic LocalDate getDate()
LocalDate
part of this date-time.
This returns a LocalDate
with the same year, month and day
as this date-time.
public int getYear()
This method returns the primitive int
value for the year.
The year returned by this method is proleptic as per get(YEAR)
.
To obtain the year-of-era, use get(YEAR_OF_ERA
.
public int getMonthValue()
This method returns the month as an int
from 1 to 12.
Application code is frequently clearer if the enum Month
is used by calling getMonth()
.
getMonth()
public Month getMonth()
Month
enum.
This method returns the enum Month
for the month.
This avoids confusion as to what int
values mean.
If you need access to the primitive int
value then the enum
provides the int value
.
getMonthValue()
public int getDayOfMonth()
This method returns the primitive int
value for the day-of-month.
public int getDayOfYear()
This method returns the primitive int
value for the day-of-year.
public DayOfWeek getDayOfWeek()
DayOfWeek
.
This method returns the enum DayOfWeek
for the day-of-week.
This avoids confusion as to what int
values mean.
If you need access to the primitive int
value then the enum
provides the int value
.
Additional information can be obtained from the DayOfWeek
.
This includes textual names of the values.
public OffsetDate with(TemporalAdjuster adjuster)
This returns a new OffsetDate
, based on this one, with the date adjusted.
The adjustment takes place using the specified adjuster strategy object.
Read the documentation of the adjuster to understand what adjustment will be made.
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 Adjusters
.
These include finding the "last day of the month" and "next Wednesday".
Key date-time classes also implement the TemporalAdjuster
interface,
such as Month
and MonthDay
.
The adjuster is responsible for handling special cases, such as the varying
lengths of month and leap years.
For example this code returns a date on the last day of July:
import static java.time.Month.*; import static java.time.temporal.Adjusters.*; result = offsetDate.with(JULY).with(lastDayOfMonth());
The classes LocalDate
and ZoneOffset
implement TemporalAdjuster
,
thus this method can be used to change the date or offset:
result = offsetDate.with(date); result = offsetDate.with(offset);
The result of this method is obtained by invoking the
TemporalAdjuster.adjustInto(Temporal)
method on the
specified adjuster passing this
as the argument.
This instance is immutable and unaffected by this method call.
with
in interface Temporal
adjuster
- the adjuster to use, not nullOffsetDate
based on this
with the adjustment made, not nullDateTimeException
- if the adjustment cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic OffsetDate with(TemporalField field, long newValue)
This returns a new OffsetDate
, based on this one, with the value
for the specified field changed.
This can be used to change any supported field, such as the year, month or day-of-month.
If it is not possible to set the value, because the field is not supported or for
some other reason, an exception is thrown.
In some cases, changing the specified field can cause the resulting date to become invalid, such as changing the month from 31st January to February would make the day-of-month invalid. In cases like this, the field is responsible for resolving the date. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
If the field is a ChronoField
then the adjustment is implemented here.
The OFFSET_SECONDS
field will return a date with the specified offset.
The local date is unaltered. If the new offset value is outside the valid range
then a DateTimeException
will be thrown.
The other supported fields
will behave as per
the matching method on LocalDate.with(TemporalField, long)
LocalDate}.
In this case, the offset is not part of the calculation and will be unchanged.
All other ChronoField
instances will throw a DateTimeException
.
If the field is not a ChronoField
, then the result of this method
is obtained by invoking TemporalField.doWith(Temporal, long)
passing this
as the argument. In this case, the field determines
whether and how to adjust the instant.
This instance is immutable and unaffected by this method call.
with
in interface Temporal
field
- the field to set in the result, not nullnewValue
- the new value of the field in the resultOffsetDate
based on this
with the specified field set, not nullDateTimeException
- if the field cannot be setjava.lang.ArithmeticException
- if numeric overflow occurspublic OffsetDate withYear(int year)
OffsetDate
with the year altered.
The offset does not affect the calculation and will be the same in the result.
If the day-of-month is invalid for the year, it will be changed to the last valid day of the month.
This instance is immutable and unaffected by this method call.
year
- the year to set in the result, from MIN_YEAR to MAX_YEAROffsetDate
based on this date with the requested year, not nullDateTimeException
- if the year value is invalidpublic OffsetDate withMonth(int month)
OffsetDate
with the month-of-year altered.
The offset does not affect the calculation and will be the same in the result.
If the day-of-month is invalid for the year, it will be changed to the last valid day of the month.
This instance is immutable and unaffected by this method call.
month
- the month-of-year to set in the result, from 1 (January) to 12 (December)OffsetDate
based on this date with the requested month, not nullDateTimeException
- if the month-of-year value is invalidpublic OffsetDate withDayOfMonth(int dayOfMonth)
OffsetDate
with the day-of-month altered.
If the resulting date is invalid, an exception is thrown.
The offset does not affect the calculation and will be the same in the result.
This instance is immutable and unaffected by this method call.
dayOfMonth
- the day-of-month to set in the result, from 1 to 28-31OffsetDate
based on this date with the requested day, not nullDateTimeException
- if the day-of-month value is invalidDateTimeException
- if the day-of-month is invalid for the month-yearpublic OffsetDate withDayOfYear(int dayOfYear)
OffsetDate
with the day-of-year altered.
If the resulting date is invalid, an exception is thrown.
This instance is immutable and unaffected by this method call.
dayOfYear
- the day-of-year to set in the result, from 1 to 365-366OffsetDate
based on this date with the requested day, not nullDateTimeException
- if the day-of-year value is invalidDateTimeException
- if the day-of-year is invalid for the yearpublic OffsetDate plus(TemporalAdder adder)
This method returns a new date based on this date with the specified period added.
The adder is typically Period
but may be any other type implementing
the TemporalAdder
interface.
The calculation is delegated to the specified adjuster, which typically calls
back to plus(long, TemporalUnit)
.
The offset is not part of the calculation and will be unchanged in the result.
This instance is immutable and unaffected by this method call.
plus
in interface Temporal
adder
- the adder to use, not nullOffsetDate
based on this date with the addition made, not nullDateTimeException
- if the addition cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic OffsetDate plus(long amountToAdd, TemporalUnit unit)
This method returns a new date based on this date with the specified period added. This can be used to add any period that is defined by a unit, for example to add years, months or days. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation. The offset is not part of the calculation and will be unchanged in the result.
This instance is immutable and unaffected by this method call.
plus
in interface Temporal
amountToAdd
- the amount of the unit to add to the result, may be negativeunit
- the unit of the period to add, not nullOffsetDate
based on this date with the specified period added, not nullDateTimeException
- if the unit cannot be added to this typepublic OffsetDate plusYears(long years)
OffsetDate
with the specified period in years added.
This method adds the specified amount to the years field in three steps:
For example, 2008-02-29 (leap year) plus one year would result in the invalid date 2009-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2009-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
years
- the years to add, may be negativeOffsetDate
based on this date with the years added, not nullDateTimeException
- if the result exceeds the supported date rangepublic OffsetDate plusMonths(long months)
OffsetDate
with the specified period in months added.
This method adds the specified amount to the months field in three steps:
For example, 2007-03-31 plus one month would result in the invalid date 2007-04-31. Instead of returning an invalid result, the last valid day of the month, 2007-04-30, is selected instead.
This instance is immutable and unaffected by this method call.
months
- the months to add, may be negativeOffsetDate
based on this date with the months added, not nullDateTimeException
- if the result exceeds the supported date rangepublic OffsetDate plusWeeks(long weeks)
OffsetDate
with the specified period in weeks added.
This method adds the specified amount in weeks to the days field incrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2008-12-31 plus one week would result in 2009-01-07.
This instance is immutable and unaffected by this method call.
weeks
- the weeks to add, may be negativeOffsetDate
based on this date with the weeks added, not nullDateTimeException
- if the result exceeds the supported date rangepublic OffsetDate plusDays(long days)
OffsetDate
with the specified period in days added.
This method adds the specified amount to the days field incrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2008-12-31 plus one day would result in 2009-01-01.
This instance is immutable and unaffected by this method call.
days
- the days to add, may be negativeOffsetDate
based on this date with the days added, not nullDateTimeException
- if the result exceeds the supported date rangepublic OffsetDate minus(TemporalSubtractor subtractor)
This method returns a new date based on this date with the specified period subtracted.
The subtractor is typically Period
but may be any other type implementing
the TemporalSubtractor
interface.
The calculation is delegated to the specified adjuster, which typically calls
back to minus(long, TemporalUnit)
.
The offset is not part of the calculation and will be unchanged in the result.
This instance is immutable and unaffected by this method call.
minus
in interface Temporal
subtractor
- the subtractor to use, not nullOffsetDate
based on this date with the subtraction made, not nullDateTimeException
- if the subtraction cannot be madejava.lang.ArithmeticException
- if numeric overflow occurspublic OffsetDate minus(long amountToSubtract, TemporalUnit unit)
This method returns a new date based on this date with the specified period subtracted. This can be used to subtract any period that is defined by a unit, for example to subtract years, months or days. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation. The offset is not part of the calculation and will be unchanged in the result.
This instance is immutable and unaffected by this method call.
minus
in interface Temporal
amountToSubtract
- the amount of the unit to subtract from the result, may be negativeunit
- the unit of the period to subtract, not nullOffsetDate
based on this date with the specified period subtracted, not nullDateTimeException
- if the unit cannot be added to this typepublic OffsetDate minusYears(long years)
OffsetDate
with the specified period in years subtracted.
This method subtracts the specified amount from the years field in three steps:
For example, 2008-02-29 (leap year) minus one year would result in the invalid date 2007-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
years
- the years to subtract, may be negativeOffsetDate
based on this date with the years subtracted, not nullDateTimeException
- if the result exceeds the supported date rangepublic OffsetDate minusMonths(long months)
OffsetDate
with the specified period in months subtracted.
This method subtracts the specified amount from the months field in three steps:
For example, 2007-03-31 minus one month would result in the invalid date 2007-02-31. Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
months
- the months to subtract, may be negativeOffsetDate
based on this date with the months subtracted, not nullDateTimeException
- if the result exceeds the supported date rangepublic OffsetDate minusWeeks(long weeks)
OffsetDate
with the specified period in weeks subtracted.
This method subtracts the specified amount in weeks from the days field decrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2009-01-07 minus one week would result in 2008-12-31.
This instance is immutable and unaffected by this method call.
weeks
- the weeks to subtract, may be negativeOffsetDate
based on this date with the weeks subtracted, not nullDateTimeException
- if the result exceeds the supported date rangepublic OffsetDate minusDays(long days)
OffsetDate
with the specified number of days subtracted.
This method subtracts the specified amount from the days field decrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2009-01-01 minus one day would result in 2008-12-31.
This instance is immutable and unaffected by this method call.
days
- the days to subtract, may be negativeOffsetDate
based on this date with the days subtracted, not nullDateTimeException
- if the result exceeds the supported date rangepublic <R> R query(TemporalQuery<R> query)
This queries this date using the specified query strategy object.
The TemporalQuery
object defines the logic to be used to
obtain the result. Read the documentation of the query to understand
what the result of this method will be.
The result of this method is obtained by invoking the
TemporalQuery.queryFrom(TemporalAccessor)
method on the
specified query passing this
as the argument.
query
in interface TemporalAccessor
R
- the type of the resultquery
- the query to invoke, not nullDateTimeException
- if unable to query (defined by the query)java.lang.ArithmeticException
- if numeric overflow occurs (defined by the query)public Temporal adjustInto(Temporal temporal)
This returns a temporal object of the same observable type as the input with the offset and date changed to be the same as this.
The adjustment is equivalent to using Temporal.with(TemporalField, long)
twice, passing ChronoField.OFFSET_SECONDS
and
ChronoField.EPOCH_DAY
as the fields.
In most cases, it is clearer to reverse the calling pattern by using
Temporal.with(TemporalAdjuster)
:
// these two lines are equivalent, but the second approach is recommended temporal = thisOffsetDate.adjustInto(temporal); temporal = temporal.with(thisOffsetDate);
This instance is immutable and unaffected by this method call.
adjustInto
in interface TemporalAdjuster
temporal
- the target object to be adjusted, not nullDateTimeException
- if unable to make the adjustmentjava.lang.ArithmeticException
- if numeric overflow occurspublic long periodUntil(Temporal endDate, TemporalUnit unit)
This calculates the period between two dates in terms of a single unit.
The start and end points are this
and the specified date.
The result will be negative if the end is before the start.
For example, the period in days between two dates can be calculated
using startDate.periodUntil(endDate, DAYS)
.
The Temporal
passed to this method must be an OffsetDate
.
If the offset differs between the two times, then the specified
end time is normalized to have the same offset as this time.
The calculation returns a whole number, representing the number of complete units between the two dates. For example, the period in months between 2012-06-15Z and 2012-08-14Z will only be one month as it is one day short of two months.
This method operates in association with TemporalUnit.between(R, R)
.
The result of this method is a long
representing the amount of
the specified unit. By contrast, the result of between
is an
object that can be used directly in addition/subtraction:
long period = start.periodUntil(end, MONTHS); // this method dateTime.plus(MONTHS.between(start, end)); // use in plus/minus
The calculation is implemented in this method for ChronoUnit
.
The units DAYS
, WEEKS
, MONTHS
, YEARS
,
DECADES
, CENTURIES
, MILLENNIA
and ERAS
are supported. 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 Temporal
endDate
- the end date, which must be an OffsetDate
, not nullunit
- the unit to measure the period in, not nullDateTimeException
- if the period cannot be calculatedjava.lang.ArithmeticException
- if numeric overflow occurspublic OffsetDateTime atTime(LocalTime time)
This combines this date with the specified time to form an OffsetDateTime
.
All possible combinations of date and time are valid.
This instance is immutable and unaffected by this method call.
time
- the time to combine with, not nullpublic int compareTo(OffsetDate other)
OffsetDate
to another date.
The comparison is based first on the UTC equivalent instant, then on the local date.
It is "consistent with equals", as defined by Comparable
.
For example, the following is the comparator order:
equals()
.
To compare the underlying local date of two TemporalAccessor
instances,
use ChronoField.EPOCH_DAY
as a comparator.
compareTo
in interface java.lang.Comparable<OffsetDate>
other
- the other date to compare to, not nullpublic boolean isAfter(OffsetDate other)
OffsetDate
is after midnight at the start of the specified date.
This method differs from the comparison in compareTo(java.time.temporal.OffsetDate)
in that it
only compares the instant of the date. This is equivalent to using
date1.toEpochSecond().isAfter(date2.toEpochSecond())
.
other
- the other date to compare to, not nullpublic boolean isBefore(OffsetDate other)
OffsetDate
is before midnight at the start of the specified date.
This method differs from the comparison in compareTo(java.time.temporal.OffsetDate)
in that it
only compares the instant of the date. This is equivalent to using
date1.toEpochSecond().isBefore(date2.toEpochSecond())
.
other
- the other date to compare to, not nullpublic boolean isEqual(OffsetDate other)
OffsetDate
equals midnight at the start of the specified date.
This method differs from the comparison in compareTo(java.time.temporal.OffsetDate)
and equals(java.lang.Object)
in that it only compares the instant of the date. This is equivalent to using
date1.toEpochSecond().equals(date2.toEpochSecond())
.
other
- the other date to compare to, not nullpublic boolean equals(java.lang.Object obj)
The comparison is based on the local-date and the offset.
To compare for the same instant on the time-line, use isEqual(OffsetDate)
.
Only objects of type OffsetDate
are compared, other types return false.
To compare the underlying local date of two TemporalAccessor
instances,
use ChronoField.EPOCH_DAY
as a comparator.
equals
in class java.lang.Object
obj
- the object to check, null returns falseObject.hashCode()
,
HashMap
public int hashCode()
hashCode
in class java.lang.Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public java.lang.String toString()
String
, such as 2007-12-03+01:00
.
The output will be in the ISO-8601 format yyyy-MM-ddXXXXX
.
toString
in class java.lang.Object
public java.lang.String toString(DateTimeFormatter formatter)
String
using the formatter.
This date will be passed to the formatter
print method
.
formatter
- the formatter to use, not nullDateTimeException
- if an error occurs during printing