OffsetDateTime
Related Docs:
object OffsetDateTime
| package bp
Adjusts the specified temporal object to have the same offset, date and time as this object.
Adjusts the specified temporal object to have the same offset, date and time as this object.
This returns a temporal object of the same observable type as the input with the offset, date and time changed to be the same as this.
The adjustment is equivalent to using long)
three times, passing ChronoField#EPOCH_DAY,
ChronoField#NANO_OF_DAY and ChronoField#OFFSET_SECONDS 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 = thisOffsetDateTime.adjustInto(temporal); temporal = temporal.with(thisOffsetDateTime);
This instance is immutable and unaffected by this method call.
the target object to be adjusted, not null
the adjusted object, not null
ArithmeticException if numeric overflow occurs
DateTimeException if unable to make the adjustment
Combines this date-time with a time-zone to create a ZonedDateTime
ensuring that the result has the same instant.
Combines this date-time with a time-zone to create a ZonedDateTime
ensuring that the result has the same instant.
This returns a ZonedDateTime formed from this date-time and the specified time-zone.
This conversion will ignore the visible local date-time and use the underlying instant instead.
This avoids any problems with local time-line gaps or overlaps.
The result might have different values for fields such as hour, minute an even day.
To attempt to retain the values of the fields, use #atZoneSimilarLocal(ZoneId).
To use the offset as the zone ID, use #toZonedDateTime().
the time-zone to use, not null
the zoned date-time formed from this date-time, not null
Combines this date-time with a time-zone to create a ZonedDateTime
trying to keep the same local date and time.
Combines this date-time with a time-zone to create a ZonedDateTime
trying to keep the same local date and time.
This returns a ZonedDateTime formed from this date-time and the specified time-zone.
Where possible, the result will have the same local date-time as this object.
Time-zone rules, such as daylight savings, mean that not every time on the
local time-line exists. If the local date-time is in a gap or overlap according to
the rules then a resolver is used to determine the resultant local time and offset.
This method uses ZoneId, ZoneOffset)
to retain the offset from this instance if possible.
Finer control over gaps and overlaps is available in two ways.
If you simply want to use the later offset at overlaps then call
ZonedDateTime#withLaterOffsetAtOverlap() immediately after this method.
To create a zoned date-time at the same instant irrespective of the local time-line,
use #atZoneSameInstant(ZoneId).
To use the offset as the zone ID, use #toZonedDateTime().
the time-zone to use, not null
the zoned date-time formed from this date and the earliest valid time for the zone, not null
Compares this OffsetDateTime to another date-time.
Compares this OffsetDateTime to another date-time.
The comparison is based on the instant then on the local date-time.
It is "consistent with equals", as defined by Comparable.
For example, the following is the comparator order:
2008-12-03T10:30+01:002008-12-03T11:00+01:002008-12-03T12:00+02:002008-12-03T11:30+01:002008-12-03T12:00+01:002008-12-03T12:30+01:00Values #2 and #3 represent the same instant on the time-line.
When two values represent the same instant, the local date-time is compared
to distinguish them. This step is needed to make the ordering
consistent with equals().
the other date-time to compare to, not null
the comparator value, negative if less, positive if greater
Checks if this date-time is equal to another date-time.
Checks if this date-time is equal to another date-time.
The comparison is based on the local date-time and the offset.
To compare for the same instant on the time-line, use #isEqual.
Only objects of type OffsetDateTime are compared, other types return false.
the object to check, null returns false
true if this is equal to the other date-time
Outputs this date-time as a String using the formatter.
Outputs this date-time as a String using the formatter.
This date-time will be passed to the formatter
print method.
the formatter to use, not null
the formatted date-time string, not null
DateTimeException if an error occurs during printing
Gets the value of the specified field from this date-time as an int.
Gets the value of the specified field from this date-time as an int.
This queries this date-time 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-time, except NANO_OF_DAY, MICRO_OF_DAY,
EPOCH_DAY, EPOCH_MONTH and INSTANT_SECONDS 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.getFrom(TemporalAccessor)
passing this as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
the field to get, not null
the value for the field
ArithmeticException if numeric overflow occurs
DateTimeException if a value for the field cannot be obtained
Gets the day-of-month field.
Gets the day-of-month field.
This method returns the primitive int value for the day-of-month.
the day-of-month, from 1 to 31
Gets the day-of-week field, which is an enum DayOfWeek.
Gets the day-of-week field, which is an enum 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.
the day-of-week, not null
Gets the day-of-year field.
Gets the day-of-year field.
This method returns the primitive int value for the day-of-year.
the day-of-year, from 1 to 365, or 366 in a leap year
Gets the hour-of-day field.
Gets the hour-of-day field.
the hour-of-day, from 0 to 23
Gets the value of the specified field from this date-time as a long.
Gets the value of the specified field from this date-time as a long.
This queries this date-time 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-time.
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.getFrom(TemporalAccessor)
passing this as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
the field to get, not null
the value for the field
ArithmeticException if numeric overflow occurs
DateTimeException if a value for the field cannot be obtained
Gets the minute-of-hour field.
Gets the minute-of-hour field.
the minute-of-hour, from 0 to 59
Gets the month-of-year field using the Month enum.
Gets the month-of-year field using the 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.
the month-of-year, not null
#getMonthValue()
Gets the month-of-year field from 1 to 12.
Gets the month-of-year field from 1 to 12.
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().
the month-of-year, from 1 to 12
#getMonth()
Gets the nano-of-second field.
Gets the nano-of-second field.
the nano-of-second, from 0 to 999,999,999
Gets the zone offset, such as '+01:00'.
Gets the zone offset, such as '+01:00'.
This is the offset of the local date-time from UTC/Greenwich.
the zone offset, not null
Gets the second-of-minute field.
Gets the second-of-minute field.
the second-of-minute, from 0 to 59
Gets the year field.
Gets the year field.
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.
the year, from MIN_YEAR to MAX_YEAR
A hash code for this date-time.
A hash code for this date-time.
a suitable hash code
Checks if the instant of this date-time is after that of the specified date-time.
Checks if the instant of this date-time is after that of the specified date-time.
This method differs from the comparison in #compareTo and #equals in that it
only compares the instant of the date-time. This is equivalent to using
dateTime1.toInstant().isAfter(dateTime2.toInstant());.
the other date-time to compare to, not null
true if this is after the instant of the specified date-time
Checks if the instant of this date-time is before that of the specified date-time.
Checks if the instant of this date-time is before that of the specified date-time.
This method differs from the comparison in #compareTo in that it
only compares the instant of the date-time. This is equivalent to using
dateTime1.toInstant().isBefore(dateTime2.toInstant());.
the other date-time to compare to, not null
true if this is before the instant of the specified date-time
Checks if the instant of this date-time is equal to that of the specified date-time.
Checks if the instant of this date-time is equal to that of the specified date-time.
This method differs from the comparison in #compareTo and #equals
in that it only compares the instant of the date-time. This is equivalent to using
dateTime1.toInstant().equals(dateTime2.toInstant());.
the other date-time to compare to, not null
true if the instant equals the instant of the specified date-time
Checks if the specified unit is supported.
Checks if the specified unit is supported.
This checks if the date-time can be queried for the specified unit.
If false, then calling the plus and minus
methods will throw an exception.
Implementations must check and handle all fields defined in ChronoUnit.
If the field is supported, then true is returned, otherwise false
If the field is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.isSupportedBy(Temporal)
passing this as the argument.
Implementations must not alter this object.
the unit to check, null returns false
true if this date-time can be queried for the unit, false if not
Checks if the specified field is supported.
Checks if the specified field is supported.
This checks if this date-time 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:
NANO_OF_SECONDNANO_OF_DAYMICRO_OF_SECONDMICRO_OF_DAYMILLI_OF_SECONDMILLI_OF_DAYSECOND_OF_MINUTESECOND_OF_DAYMINUTE_OF_HOURMINUTE_OF_DAYHOUR_OF_AMPMCLOCK_HOUR_OF_AMPMHOUR_OF_DAYCLOCK_HOUR_OF_DAYAMPM_OF_DAYDAY_OF_WEEKALIGNED_DAY_OF_WEEK_IN_MONTHALIGNED_DAY_OF_WEEK_IN_YEARDAY_OF_MONTHDAY_OF_YEAREPOCH_DAYALIGNED_WEEK_OF_MONTHALIGNED_WEEK_OF_YEARMONTH_OF_YEAREPOCH_MONTHYEAR_OF_ERAYEARERAINSTANT_SECONDSOFFSET_SECONDSAll 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.
the field to check, null returns false
true if the field is supported on this date-time, false if not
Returns a copy of this date-time with the specified period subtracted.
Returns a copy of this date-time with the specified period subtracted.
This method returns a new date-time based on this date-time 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.
the amount of the unit to subtract from the result, may be negative
the unit of the period to subtract, not null
an { @code OffsetDateTime} based on this date-time with the specified period subtracted, not null
Returns a copy of this date-time with the specified period subtracted.
Returns a copy of this date-time with the specified period subtracted.
This method returns a new date-time based on this time with the specified period subtracted.
The amount is typically Period but may be any other type implementing
the TemporalAmount interface.
The calculation is delegated to the specified adjuster, which typically calls
back to 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.
the amount to subtract, not null
an { @code OffsetDateTime} based on this date-time with the subtraction made, not null
ArithmeticException if numeric overflow occurs
DateTimeException if the subtraction cannot be made
Returns a copy of this OffsetDateTime with the specified period in days subtracted.
Returns a copy of this OffsetDateTime with the specified period in days subtracted.
This method subtracts the specified amount from 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 minus one day would result in the 2009-01-01.
This instance is immutable and unaffected by this method call.
the days to subtract, may be negative
an { @code OffsetDateTime} based on this date-time with the days subtracted, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in hours subtracted.
Returns a copy of this OffsetDateTime with the specified period in hours subtracted.
This instance is immutable and unaffected by this method call.
the hours to subtract, may be negative
an { @code OffsetDateTime} based on this date-time with the hours subtracted, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in minutes subtracted.
Returns a copy of this OffsetDateTime with the specified period in minutes subtracted.
This instance is immutable and unaffected by this method call.
the minutes to subtract, may be negative
an { @code OffsetDateTime} based on this date-time with the minutes subtracted, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in months subtracted.
Returns a copy of this OffsetDateTime 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-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.
the months to subtract, may be negative
an { @code OffsetDateTime} based on this date-time with the months subtracted, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in nanoseconds subtracted.
Returns a copy of this OffsetDateTime with the specified period in nanoseconds subtracted.
This instance is immutable and unaffected by this method call.
the nanos to subtract, may be negative
an { @code OffsetDateTime} based on this date-time with the nanoseconds subtracted, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in seconds subtracted.
Returns a copy of this OffsetDateTime with the specified period in seconds subtracted.
This instance is immutable and unaffected by this method call.
the seconds to subtract, may be negative
an { @code OffsetDateTime} based on this date-time with the seconds subtracted, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in weeks subtracted.
Returns a copy of this OffsetDateTime 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, 2008-12-31 minus one week would result in the 2009-01-07.
This instance is immutable and unaffected by this method call.
the weeks to subtract, may be negative
an { @code OffsetDateTime} based on this date-time with the weeks subtracted, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in years subtracted.
Returns a copy of this OffsetDateTime 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 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.
the years to subtract, may be negative
an { @code OffsetDateTime} based on this date-time with the years subtracted, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this date-time with the specified period added.
Returns a copy of this date-time with the specified period added.
This method returns a new date-time based on this date-time 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.
the amount of the unit to add to the result, may be negative
the unit of the period to add, not null
an { @code OffsetDateTime} based on this date-time with the specified period added, not null
DateTimeException if the unit cannot be added to this type
Returns a copy of this date-time with the specified period added.
Returns a copy of this date-time with the specified period added.
This method returns a new date-time based on this time with the specified period added.
The amount is typically Period but may be any other type implementing
the TemporalAmount interface.
The calculation is delegated to the specified adjuster, which typically calls
back to 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.
the amount to add, not null
an { @code OffsetDateTime} based on this date-time with the addition made, not null
ArithmeticException if numeric overflow occurs
DateTimeException if the addition cannot be made
Returns a copy of this OffsetDateTime with the specified period in days added.
Returns a copy of this OffsetDateTime 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 the 2009-01-01.
This instance is immutable and unaffected by this method call.
the days to add, may be negative
an { @code OffsetDateTime} based on this date-time with the days added, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in hours added.
Returns a copy of this OffsetDateTime with the specified period in hours added.
This instance is immutable and unaffected by this method call.
the hours to add, may be negative
an { @code OffsetDateTime} based on this date-time with the hours added, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in minutes added.
Returns a copy of this OffsetDateTime with the specified period in minutes added.
This instance is immutable and unaffected by this method call.
the minutes to add, may be negative
an { @code OffsetDateTime} based on this date-time with the minutes added, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in months added.
Returns a copy of this OffsetDateTime 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.
the months to add, may be negative
an { @code OffsetDateTime} based on this date-time with the months added, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in nanoseconds added.
Returns a copy of this OffsetDateTime with the specified period in nanoseconds added.
This instance is immutable and unaffected by this method call.
the nanos to add, may be negative
an { @code OffsetDateTime} based on this date-time with the nanoseconds added, not null
DateTimeException if the unit cannot be added to this type
Returns a copy of this OffsetDateTime with the specified period in seconds added.
Returns a copy of this OffsetDateTime with the specified period in seconds added.
This instance is immutable and unaffected by this method call.
the seconds to add, may be negative
an { @code OffsetDateTime} based on this date-time with the seconds added, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in weeks added.
Returns a copy of this OffsetDateTime 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 the 2009-01-07.
This instance is immutable and unaffected by this method call.
the weeks to add, may be negative
an { @code OffsetDateTime} based on this date-time with the weeks added, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified period in years added.
Returns a copy of this OffsetDateTime 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.
the years to add, may be negative
an { @code OffsetDateTime} based on this date-time with the years added, not null
DateTimeException if the result exceeds the supported date range
Queries this date-time using the specified query.
Queries this date-time using the specified query.
This queries this date-time 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.
the type of the result
the query to invoke, not null
the query result, null may be returned (defined by the query)
ArithmeticException if numeric overflow occurs (defined by the query)
DateTimeException if unable to query (defined by the query)
Gets the range of valid values for the specified field.
Gets the range of valid values for the specified field.
The range object expresses the minimum and maximum valid values for a field. This date-time 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.rangeRefinedBy(TemporalAccessor)
passing this as the argument.
Whether the range can be obtained is determined by the field.
the field to query the range for, not null
the range of valid values for the field, not null
DateTimeException if the range for the field cannot be obtained
Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z.
Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z.
This allows this date-time to be converted to a value of the
epoch-seconds field. This is primarily
intended for low-level conversions rather than general application usage.
the number of seconds from the epoch of 1970-01-01T00:00:00Z
Converts this date-time to an Instant.
Converts this date-time to an Instant.
an { @code Instant} representing the same instant, not null
Gets the LocalDate part of this date-time.
Gets the LocalDate part of this date-time.
This returns a LocalDate with the same year, month and day
as this date-time.
the date part of this date-time, not null
Gets the LocalDateTime part of this offset date-time.
Gets the LocalDateTime part of this offset date-time.
This returns a LocalDateTime with the same year, month, day and time
as this date-time.
the local date-time part of this date-time, not null
Gets the LocalTime part of this date-time.
Gets the LocalTime part of this date-time.
This returns a LocalTime with the same hour, minute, second and
nanosecond as this date-time.
the time part of this date-time, not null
Converts this date-time to an OffsetTime.
Converts this date-time to an OffsetTime.
This returns an offset time with the same local time and offset.
an OffsetTime representing the time and offset, not null
Outputs this date-time as a String, such as 2007-12-03T10:15:30+01:00.
Outputs this date-time as a String, such as 2007-12-03T10:15:30+01:00.
The output will be one of the following ISO-8601 formats:
yyyy-MM-dd'T'HH:mmXXXXXyyyy-MM-dd'T'HH:mm:ssXXXXXyyyy-MM-dd'T'HH:mm:ss.SSSXXXXXyyyy-MM-dd'T'HH:mm:ss.SSSSSSXXXXXyyyy-MM-dd'T'HH:mm:ss.SSSSSSSSSXXXXXThe format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.
a string representation of this date-time, not null
Converts this date-time to a ZonedDateTime using the offset as the zone ID.
Converts this date-time to a ZonedDateTime using the offset as the zone ID.
This creates the simplest possible ZonedDateTime using the offset
as the zone ID.
To control the time-zone used, see #atZoneSameInstant(ZoneId) and
#atZoneSimilarLocal(ZoneId).
a zoned date-time representing the same local date-time and offset, not null
Returns a copy of this OffsetDateTime with the time truncated.
Returns a copy of this OffsetDateTime with the time truncated.
Truncation returns a copy of the original date-time with fields
smaller than the specified unit set to zero.
For example, truncating with the minutes unit
will set the second-of-minute and nano-of-second field to zero.
The unit must have a duration
that divides into the length of a standard day without remainder.
This includes all supplied time units on ChronoUnit and
DAYS. Other units throw an exception.
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.
the unit to truncate to, not null
an { @code OffsetDateTime} based on this date-time with the time truncated, not null
DateTimeException if unable to truncate
Calculates the period between this date-time and another date-time in terms of the specified unit.
Calculates the period between this date-time and another date-time in terms of the specified unit.
This calculates the period between two date-times in terms of a single unit.
The start and end points are this and the specified date-time.
The result will be negative if the end is before the start.
For example, the period in days between two date-times can be calculated
using startDateTime.until(endDateTime, DAYS).
The Temporal passed to this method must be an OffsetDateTime.
If the offset differs between the two date-times, the specified
end date-time is normalized to have the same offset as this date-time.
The calculation returns a whole number, representing the number of complete units between the two date-times. For example, the period in months between 2012-06-15T00:00Z and 2012-08-14T23:59Z will only be one month as it is one minute short of two months.
This method operates in association with TemporalUnit#between.
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.until(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 NANOS, MICROS, MILLIS, SECONDS,
MINUTES, HOURS and HALF_DAYS, 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.
the end date-time, which is converted to an { @code OffsetDateTime}, not null
the unit to measure the period in, not null
the amount of the period between this date-time and the end date-time
ArithmeticException if numeric overflow occurs
DateTimeException if the period cannot be calculated
Returns a copy of this date-time with the specified field set to a new value.
Returns a copy of this date-time with the specified field set to a new value.
This returns a new OffsetDateTime, 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-time 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 INSTANT_SECONDS field will return a date-time with the specified instant.
The offset and nano-of-second are unchanged.
If the new instant value is outside the valid range then a DateTimeException will be thrown.
The OFFSET_SECONDS field will return a date-time with the specified offset.
The local date-time 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 long) LocalDateTime.
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.adjustInto(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.
the field to set in the result, not null
the new value of the field in the result
an { @code OffsetDateTime} based on { @code this} with the specified field set, not null
ArithmeticException if numeric overflow occurs
DateTimeException if the field cannot be set
Returns an adjusted copy of this date-time.
Returns an adjusted copy of this date-time.
This returns a new OffsetDateTime, based on this one, with the date-time 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 TemporalAdjusters.
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 org.threeten.bp.Month.*; import static org.threeten.bp.temporal.Adjusters.*; result = offsetDateTime.with(JULY).with(lastDayOfMonth());
The classes LocalDate, LocalTime and ZoneOffset implement
TemporalAdjuster, thus this method can be used to change the date, time or offset:
result = offsetDateTime.with(date); result = offsetDateTime.with(time); result = offsetDateTime.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.
the adjuster to use, not null
an { @code OffsetDateTime} based on { @code this} with the adjustment made, not null
ArithmeticException if numeric overflow occurs
DateTimeException if the adjustment cannot be made
Returns a copy of this OffsetDateTime with the day-of-month altered.
Returns a copy of this OffsetDateTime with the day-of-month altered.
If the resulting OffsetDateTime 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.
the day-of-month to set in the result, from 1 to 28-31
an { @code OffsetDateTime} based on this date-time with the requested day, not null
DateTimeException if the day-of-month is invalid for the month-year
Returns a copy of this OffsetDateTime with the day-of-year altered.
Returns a copy of this OffsetDateTime with the day-of-year altered.
If the resulting OffsetDateTime is invalid, an exception is thrown.
This instance is immutable and unaffected by this method call.
the day-of-year to set in the result, from 1 to 365-366
an { @code OffsetDateTime} based on this date with the requested day, not null
DateTimeException if the day-of-year is invalid for the year
Returns a copy of this OffsetDateTime with the hour-of-day value altered.
Returns a copy of this OffsetDateTime with the hour-of-day value altered.
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.
the hour-of-day to set in the result, from 0 to 23
an { @code OffsetDateTime} based on this date-time with the requested hour, not null
DateTimeException if the hour value is invalid
Returns a copy of this OffsetDateTime with the minute-of-hour value altered.
Returns a copy of this OffsetDateTime with the minute-of-hour value altered.
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.
the minute-of-hour to set in the result, from 0 to 59
an { @code OffsetDateTime} based on this date-time with the requested minute, not null
DateTimeException if the minute value is invalid
Returns a copy of this OffsetDateTime with the month-of-year altered.
Returns a copy of this OffsetDateTime 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.
the month-of-year to set in the result, from 1 (January) to 12 (December)
an { @code OffsetDateTime} based on this date-time with the requested month, not null
DateTimeException if the month-of-year value is invalid
Returns a copy of this OffsetDateTime with the nano-of-second value altered.
Returns a copy of this OffsetDateTime with the nano-of-second value altered.
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.
the nano-of-second to set in the result, from 0 to 999,999,999
an { @code OffsetDateTime} based on this date-time with the requested nanosecond, not null
DateTimeException if the nanos value is invalid
Returns a copy of this OffsetDateTime with the specified offset ensuring
that the result is at the same instant.
Returns a copy of this OffsetDateTime with the specified offset ensuring
that the result is at the same instant.
This method returns an object with the specified ZoneOffset and a LocalDateTime
adjusted by the difference between the two offsets.
This will result in the old and new objects representing the same instant.
This is useful for finding the local time in a different offset.
For example, if this time represents 2007-12-03T10:30+02:00 and the offset specified is
+03:00, then this method will return 2007-12-03T11:30+03:00.
To change the offset without adjusting the local time use #withOffsetSameLocal.
This instance is immutable and unaffected by this method call.
the zone offset to change to, not null
an { @code OffsetDateTime} based on this date-time with the requested offset, not null
DateTimeException if the result exceeds the supported date range
Returns a copy of this OffsetDateTime with the specified offset ensuring
that the result has the same local date-time.
Returns a copy of this OffsetDateTime with the specified offset ensuring
that the result has the same local date-time.
This method returns an object with the same LocalDateTime and the specified ZoneOffset.
No calculation is needed or performed.
For example, if this time represents 2007-12-03T10:30+02:00 and the offset specified is
+03:00, then this method will return 2007-12-03T10:30+03:00.
To take into account the difference between the offsets, and adjust the time fields,
use #withOffsetSameInstant.
This instance is immutable and unaffected by this method call.
the zone offset to change to, not null
an { @code OffsetDateTime} based on this date-time with the requested offset, not null
Returns a copy of this OffsetDateTime with the second-of-minute value altered.
Returns a copy of this OffsetDateTime with the second-of-minute value altered.
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.
the second-of-minute to set in the result, from 0 to 59
an { @code OffsetDateTime} based on this date-time with the requested second, not null
DateTimeException if the second value is invalid
Returns a copy of this OffsetDateTime with the year altered.
Returns a copy of this OffsetDateTime 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.
the year to set in the result, from MIN_YEAR to MAX_YEAR
an { @code OffsetDateTime} based on this date-time with the requested year, not null
DateTimeException if the year value is invalid
A date-time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as
2007-12-03T10:15:30+01:00.OffsetDateTimeis an immutable representation of a date-time with an offset. This class stores all date and time fields, to a precision of nanoseconds, as well as the offset from UTC/Greenwich. For example, the value "2nd October 2007 at 13:45.30.123456789 +02:00" can be stored in anOffsetDateTime.OffsetDateTime,ZonedDateTimeandInstantall store an instant on the time-line to nanosecond precision.Instantis the simplest, simply representing the instant.OffsetDateTimeadds to the instant the offset from UTC/Greenwich, which allows the local date-time to be obtained.ZonedDateTimeadds full time-zone rules.It is intended that
ZonedDateTimeorInstantis used to model data in simpler applications. This class may be used when modeling date-time concepts in more detail, or when communicating to a database or in a network protocol.Specification for implementors
This class is immutable and thread-safe.