OffsetDate (ThreeTen backport 0.7.2 API)

java.lang.Object
- org.threeten.bp.jdk8.DefaultInterfaceTemporalAccessor
- - org.threeten.bp.OffsetDate

All Implemented Interfaces:

Serializable, Comparable<OffsetDate>, Temporal, TemporalAccessor, TemporalAdjuster
```
public final class OffsetDate
extends DefaultInterfaceTemporalAccessor
implements Temporal, TemporalAdjuster, Comparable<OffsetDate>, Serializable
```
A date with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as 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.
Specification for implementors
This class is immutable and thread-safe.

See Also:
Serialized Form

Field Summary

Fields
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'.

Method Summary

Methods
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(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(CharSequence text)` Obtains an instance of `OffsetDate` from a text string such as `2007-12-03+01:00`.
`static OffsetDate`	`parse(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.
`String`	`toString()` Outputs this date as a `String`, such as `2007-12-03+01:00`.
`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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MIN
```
public static final OffsetDate MIN
```
    The minimum supported 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.
  - MAX
```
public static final OffsetDate MAX
```
    The maximum supported 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.
- Method Detail
  - now
```
public static OffsetDate now()
```
    Obtains the current date 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. 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.
    
    Returns:
    the current date using the system clock, not null
  - now
```
public static OffsetDate now(ZoneId zone)
```
    Obtains the current date 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. 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.
    
    Parameters:
    zone - the zone ID to use, not null
    
    Returns:
    the current date using the system clock, not null
  - now
```
public static OffsetDate now(Clock clock)
```
    Obtains the current date from the specified 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.
    
    Parameters:
    clock - the clock to use, not null
    
    Returns:
    the current date, not null
  - of
```
public static OffsetDate of(LocalDate date,
            ZoneOffset offset)
```
    Obtains an instance of OffsetDate from a local date and an offset.
    
    Parameters:
    date - the local date, not null
    offset - the zone offset, not null
    
    Returns:
    the offset date, not null
  - ofInstant
```
public static OffsetDate ofInstant(Instant instant,
                   ZoneId zone)
```
    Obtains an instance of 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.
    
    Parameters:
    instant - the instant to create the time from, not null
    zone - the time-zone, which may be an offset, not null
    
    Returns:
    the offset time, not null
  - from
```
public static OffsetDate from(TemporalAccessor temporal)
```
    Obtains an instance of 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.
    
    Parameters:
    temporal - the temporal object to convert, not null
    
    Returns:
    the offset date, not null
    
    Throws:
    
    DateTimeException - if unable to convert to an OffsetDate
  - parse
```
public static OffsetDate parse(CharSequence text)
```
    Obtains an instance of 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().
    
    Parameters:
    text - the text to parse such as "2007-12-03+01:00", not null
    
    Returns:
    the parsed offset date, not null
    
    Throws:
    
    DateTimeParseException - if the text cannot be parsed
  - parse
```
public static OffsetDate parse(CharSequence text,
               DateTimeFormatter formatter)
```
    Obtains an instance of OffsetDate from a text string using a specific formatter.
    The text is parsed using the formatter, returning a date.
    
    Parameters:
    text - the text to parse, not null
    formatter - the formatter to use, not null
    
    Returns:
    the parsed offset date, not null
    
    Throws:
    
    DateTimeParseException - if the text cannot be parsed
  - isSupported
```
public boolean isSupported(TemporalField field)
```
    Checks if the specified field is supported.
    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
    All other 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.
    Specified by:
    
    isSupported in interface TemporalAccessor
    
    Parameters:
    field - the field to check, null returns false
    
    Returns:
    true if the field is supported on this date, false if not
  - range
```
public ValueRange range(TemporalField 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 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.
    
    Specified by:
    
    range in interface TemporalAccessor
    
    Overrides:
    
    range in class DefaultInterfaceTemporalAccessor
    
    Parameters:
    field - the field to query the range for, not null
    
    Returns:
    the range of valid values for the field, not null
    
    Throws:
    
    DateTimeException - if the range for the field cannot be obtained
  - get
```
public int get(TemporalField field)
```
    Gets the value of the specified field from this date as an 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.
    
    Specified by:
    
    get in interface TemporalAccessor
    
    Overrides:
    
    get in class DefaultInterfaceTemporalAccessor
    
    Parameters:
    field - the field to get, not null
    
    Returns:
    the value for the field
    
    Throws:
    
    DateTimeException - if a value for the field cannot be obtained
    
    ArithmeticException - if numeric overflow occurs
  - getLong
```
public long getLong(TemporalField field)
```
    Gets the value of the specified field from this date as a 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.
    
    Specified by:
    
    getLong in interface TemporalAccessor
    
    Parameters:
    field - the field to get, not null
    
    Returns:
    the value for the field
    
    Throws:
    
    DateTimeException - if a value for the field cannot be obtained
    
    ArithmeticException - if numeric overflow occurs
  - getOffset
```
public ZoneOffset getOffset()
```
    Gets the zone offset, such as '+01:00'.
    This is the offset of the local date from UTC/Greenwich.
    
    Returns:
    the zone offset, not null
  - withOffset
```
public OffsetDate withOffset(ZoneOffset offset)
```
    Returns a copy of this 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.
    
    Parameters:
    offset - the zone offset to change to, not null
    
    Returns:
    an OffsetDate based on this date with the requested offset, not null
  - getDate
```
public LocalDate getDate()
```
    Gets the LocalDate part of this date-time.
    This returns a LocalDate with the same year, month and day as this date-time.
    
    Returns:
    the date part of this date-time, not null
  - getYear
```
public int getYear()
```
    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.
    
    Returns:
    the year, from MIN_YEAR to MAX_YEAR
  - getMonthValue
```
public int getMonthValue()
```
    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().
    
    Returns:
    the month-of-year, from 1 to 12
    See Also:
    getMonth()
  - getMonth
```
public Month getMonth()
```
    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.
    
    Returns:
    the month-of-year, not null
    See Also:
    getMonthValue()
  - getDayOfMonth
```
public int getDayOfMonth()
```
    Gets the day-of-month field.
    This method returns the primitive int value for the day-of-month.
    
    Returns:
    the day-of-month, from 1 to 31
  - getDayOfYear
```
public int getDayOfYear()
```
    Gets the day-of-year field.
    This method returns the primitive int value for the day-of-year.
    
    Returns:
    the day-of-year, from 1 to 365, or 366 in a leap year
  - getDayOfWeek
```
public DayOfWeek getDayOfWeek()
```
    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.
    
    Returns:
    the day-of-week, not null
  - with
```
public OffsetDate with(TemporalAdjuster adjuster)
```
    Returns an adjusted copy of this date.
    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 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 = 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.
    Specified by:
    
    with in interface Temporal
    
    Parameters:
    adjuster - the adjuster to use, not null
    
    Returns:
    an OffsetDate based on this with the adjustment made, not null
    
    Throws:
    
    DateTimeException - if the adjustment cannot be made
    
    ArithmeticException - if numeric overflow occurs
  - with
```
public OffsetDate with(TemporalField field,
              long newValue)
```
    Returns a copy of this date with the specified field set to a new value.
    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.
    
    Specified by:
    
    with in interface Temporal
    
    Parameters:
    field - the field to set in the result, not null
    newValue - the new value of the field in the result
    
    Returns:
    an OffsetDate based on this with the specified field set, not null
    
    Throws:
    
    DateTimeException - if the field cannot be set
    
    ArithmeticException - if numeric overflow occurs
  - withYear
```
public OffsetDate withYear(int year)
```
    Returns a copy of this 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.
    
    Parameters:
    year - the year to set in the result, from MIN_YEAR to MAX_YEAR
    
    Returns:
    an OffsetDate based on this date with the requested year, not null
    
    Throws:
    
    DateTimeException - if the year value is invalid
  - withMonth
```
public OffsetDate withMonth(int month)
```
    Returns a copy of this 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.
    
    Parameters:
    month - the month-of-year to set in the result, from 1 (January) to 12 (December)
    
    Returns:
    an OffsetDate based on this date with the requested month, not null
    
    Throws:
    
    DateTimeException - if the month-of-year value is invalid
  - withDayOfMonth
```
public OffsetDate withDayOfMonth(int dayOfMonth)
```
    Returns a copy of this 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.
    
    Parameters:
    dayOfMonth - the day-of-month to set in the result, from 1 to 28-31
    
    Returns:
    an OffsetDate based on this date with the requested day, not null
    
    Throws:
    
    DateTimeException - if the day-of-month value is invalid
    
    DateTimeException - if the day-of-month is invalid for the month-year
  - withDayOfYear
```
public OffsetDate withDayOfYear(int dayOfYear)
```
    Returns a copy of this 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.
    
    Parameters:
    dayOfYear - the day-of-year to set in the result, from 1 to 365-366
    
    Returns:
    an OffsetDate based on this date with the requested day, not null
    
    Throws:
    
    DateTimeException - if the day-of-year value is invalid
    
    DateTimeException - if the day-of-year is invalid for the year
  - plus
```
public OffsetDate plus(TemporalAdder adder)
```
    Returns a copy of this date with the specified period added.
    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.
    
    Specified by:
    
    plus in interface Temporal
    
    Parameters:
    adder - the adder to use, not null
    
    Returns:
    an OffsetDate based on this date with the addition made, not null
    
    Throws:
    
    DateTimeException - if the addition cannot be made
    
    ArithmeticException - if numeric overflow occurs
  - plus
```
public OffsetDate plus(long amountToAdd,
              TemporalUnit unit)
```
    Returns a copy of this date with the specified period added.
    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.
    
    Specified by:
    
    plus in interface Temporal
    
    Parameters:
    amountToAdd - the amount of the unit to add to the result, may be negative
    unit - the unit of the period to add, not null
    
    Returns:
    an OffsetDate based on this date with the specified period added, not null
    
    Throws:
    
    DateTimeException - if the unit cannot be added to this type
  - plusYears
```
public OffsetDate plusYears(long years)
```
    Returns a copy of this OffsetDate with the specified period in years added.
    This method adds the specified amount to the years field in three steps:
    1. Add the input years to the year field
    2. Check if the resulting date would be invalid
    3. Adjust the day-of-month to the last valid day if necessary
    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.
    Parameters:
    years - the years to add, may be negative
    
    Returns:
    an OffsetDate based on this date with the years added, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported date range
  - plusMonths
```
public OffsetDate plusMonths(long months)
```
    Returns a copy of this OffsetDate with the specified period in months added.
    This method adds the specified amount to the months field in three steps:
    1. Add the input months to the month-of-year field
    2. Check if the resulting date would be invalid
    3. Adjust the day-of-month to the last valid day if necessary
    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.
    Parameters:
    months - the months to add, may be negative
    
    Returns:
    an OffsetDate based on this date with the months added, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported date range
  - plusWeeks
```
public OffsetDate plusWeeks(long weeks)
```
    Returns a copy of this 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.
    
    Parameters:
    weeks - the weeks to add, may be negative
    
    Returns:
    an OffsetDate based on this date with the weeks added, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported date range
  - plusDays
```
public OffsetDate plusDays(long days)
```
    Returns a copy of this 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.
    
    Parameters:
    days - the days to add, may be negative
    
    Returns:
    an OffsetDate based on this date with the days added, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported date range
  - minus
```
public OffsetDate minus(TemporalSubtractor subtractor)
```
    Returns a copy of this date with the specified period subtracted.
    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.
    
    Specified by:
    
    minus in interface Temporal
    
    Parameters:
    subtractor - the subtractor to use, not null
    
    Returns:
    an OffsetDate based on this date with the subtraction made, not null
    
    Throws:
    
    DateTimeException - if the subtraction cannot be made
    
    ArithmeticException - if numeric overflow occurs
  - minus
```
public OffsetDate minus(long amountToSubtract,
               TemporalUnit unit)
```
    Returns a copy of this date with the specified period subtracted.
    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.
    
    Specified by:
    
    minus in interface Temporal
    
    Parameters:
    amountToSubtract - the amount of the unit to subtract from the result, may be negative
    unit - the unit of the period to subtract, not null
    
    Returns:
    an OffsetDate based on this date with the specified period subtracted, not null
    
    Throws:
    
    DateTimeException - if the unit cannot be added to this type
  - minusYears
```
public OffsetDate minusYears(long years)
```
    Returns a copy of this OffsetDate with the specified period in years subtracted.
    This method subtracts the specified amount from the years field in three steps:
    1. Subtract the input years to the year field
    2. Check if the resulting date would be invalid
    3. Adjust the day-of-month to the last valid day if necessary
    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.
    Parameters:
    years - the years to subtract, may be negative
    
    Returns:
    an OffsetDate based on this date with the years subtracted, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported date range
  - minusMonths
```
public OffsetDate minusMonths(long months)
```
    Returns a copy of this OffsetDate with the specified period in months subtracted.
    This method subtracts the specified amount from the months field in three steps:
    1. Subtract the input months to the month-of-year field
    2. Check if the resulting date would be invalid
    3. Adjust the day-of-month to the last valid day if necessary
    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.
    Parameters:
    months - the months to subtract, may be negative
    
    Returns:
    an OffsetDate based on this date with the months subtracted, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported date range
  - minusWeeks
```
public OffsetDate minusWeeks(long weeks)
```
    Returns a copy of this 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.
    
    Parameters:
    weeks - the weeks to subtract, may be negative
    
    Returns:
    an OffsetDate based on this date with the weeks subtracted, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported date range
  - minusDays
```
public OffsetDate minusDays(long days)
```
    Returns a copy of this 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.
    
    Parameters:
    days - the days to subtract, may be negative
    
    Returns:
    an OffsetDate based on this date with the days subtracted, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported date range
  - query
```
public <R> R query(TemporalQuery<R> query)
```
    Queries this date using the specified 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.
    
    Specified by:
    
    query in interface TemporalAccessor
    
    Overrides:
    
    query in class DefaultInterfaceTemporalAccessor
    
    Type Parameters:
    R - the type of the result
    Parameters:
    query - the query to invoke, not null
    
    Returns:
    the query result, null may be returned (defined by the query)
    
    Throws:
    
    DateTimeException - if unable to query (defined by the query)
    
    ArithmeticException - if numeric overflow occurs (defined by the query)
  - adjustInto
```
public Temporal adjustInto(Temporal temporal)
```
    Adjusts the specified temporal object to have the same offset and date as this object.
    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.
    Specified by:
    
    adjustInto in interface TemporalAdjuster
    
    Parameters:
    temporal - the target object to be adjusted, not null
    
    Returns:
    the adjusted object, not null
    
    Throws:
    
    DateTimeException - if unable to make the adjustment
    
    ArithmeticException - if numeric overflow occurs
  - periodUntil
```
public long periodUntil(Temporal endDate,
               TemporalUnit unit)
```
    Calculates the period between this date and another date in terms of the specified 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.
    Specified by:
    
    periodUntil in interface Temporal
    
    Parameters:
    endDate - the end date, which must be an OffsetDate, not null
    unit - the unit to measure the period in, not null
    
    Returns:
    the amount of the period between this date and the end date
    
    Throws:
    
    DateTimeException - if the period cannot be calculated
    
    ArithmeticException - if numeric overflow occurs
  - atTime
```
public OffsetDateTime atTime(LocalTime time)
```
    Returns an offset date-time formed from this date at the specified 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.
    
    Parameters:
    time - the time to combine with, not null
    
    Returns:
    the offset date-time formed from this date and the specified time, not null
  - compareTo
```
public int compareTo(OffsetDate other)
```
    Compares this 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:
    1. 2008-06-29-11:00
    2. 2008-06-29-12:00
    3. 2008-06-30+12:00
    4. 2008-06-29-13:00
    Values #2 and #3 represent the same instant on the time-line. When two values represent the same instant, the local date is compared to distinguish them. This step is needed to make the ordering consistent with equals().
    To compare the underlying local date of two TemporalAccessor instances, use ChronoField.EPOCH_DAY as a comparator.
    Specified by:
    
    compareTo in interface Comparable<OffsetDate>
    
    Parameters:
    other - the other date to compare to, not null
    
    Returns:
    the comparator value, negative if less, positive if greater
  - isAfter
```
public 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.
    This method differs from the comparison in compareTo(org.threeten.bp.OffsetDate) in that it only compares the instant of the date. This is equivalent to using date1.toEpochSecond().isAfter(date2.toEpochSecond()).
    
    Parameters:
    other - the other date to compare to, not null
    
    Returns:
    true if this is after the instant of the specified date
  - isBefore
```
public 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.
    This method differs from the comparison in compareTo(org.threeten.bp.OffsetDate) in that it only compares the instant of the date. This is equivalent to using date1.toEpochSecond().isBefore(date2.toEpochSecond()).
    
    Parameters:
    other - the other date to compare to, not null
    
    Returns:
    true if this is before the instant of the specified date
  - isEqual
```
public 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.
    This method differs from the comparison in compareTo(org.threeten.bp.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()).
    
    Parameters:
    other - the other date to compare to, not null
    
    Returns:
    true if the instant equals the instant of the specified date
  - equals
```
public boolean equals(Object obj)
```
    Checks if this date is equal to another date.
    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.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to check, null returns false
    
    Returns:
    true if this is equal to the other date
  - hashCode
```
public int hashCode()
```
    A hash code for this date.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a suitable hash code
  - toString
```
public String toString()
```
    Outputs this date as a String, such as 2007-12-03+01:00.
    The output will be in the ISO-8601 format yyyy-MM-ddXXXXX.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this date, not null
  - toString
```
public String toString(DateTimeFormatter formatter)
```
    Outputs this date as a String using the formatter.
    This date will be passed to the formatter print method.
    
    Parameters:
    formatter - the formatter to use, not null
    
    Returns:
    the formatted date string, not null
    
    Throws:
    
    DateTimeException - if an error occurs during printing

Class OffsetDate

Specification for implementors

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN

MAX

Method Detail

now

now

now

of

ofInstant

from

parse

parse

isSupported

range

get

getLong

getOffset

withOffset

getDate

getYear

getMonthValue

getMonth

getDayOfMonth

getDayOfYear

getDayOfWeek

with

with

withYear

withMonth

withDayOfMonth

withDayOfYear

plus

plus

plusYears

plusMonths

plusWeeks

plusDays

minus

minus

minusYears

minusMonths

minusWeeks

minusDays

query

adjustInto

periodUntil

atTime

compareTo

isAfter

isBefore

isEqual

equals

hashCode

toString

toString