- * {@code 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 {@code OffsetDate}. - * - *
- * This will query the {@link java.time.Clock#systemDefaultZone() 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. - * - * @return the current date using the system clock, not null - */ - public static OffsetDate now() { - return now(Clock.systemDefaultZone()); - } - - /** - * Obtains the current date from the system clock in the specified time-zone. - *
- * This will query the {@link Clock#system(java.time.ZoneId) 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. - * - * @param zone the zone ID to use, not null - * @return the current date using the system clock, not null - */ - public static OffsetDate now(ZoneId zone) { - return now(Clock.system(zone)); - } - - /** - * 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 {@link Clock dependency injection}. - * - * @param clock the clock to use, not null - * @return the current date, not null - */ - public static OffsetDate now(Clock clock) { - Objects.requireNonNull(clock, "clock"); - final Instant now = clock.instant(); // called once - return ofInstant(now, clock.getZone().getRules().getOffset(now)); - } - - //----------------------------------------------------------------------- - /** - * Obtains an instance of {@code OffsetDate} from a local date and an offset. - * - * @param date the local date, not null - * @param offset the zone offset, not null - * @return the offset date, not null - */ - public static OffsetDate of(LocalDate date, ZoneOffset offset) { - return new OffsetDate(date, offset); - } - - //----------------------------------------------------------------------- - /** - * Obtains an instance of {@code OffsetDate} from an {@code 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. - * - * @param instant the instant to create the time from, not null - * @param zone the time-zone, which may be an offset, not null - * @return the offset time, not null - */ - public static OffsetDate ofInstant(Instant instant, ZoneId zone) { - Objects.requireNonNull(instant, "instant"); - Objects.requireNonNull(zone, "zone"); - ZoneRules rules = zone.getRules(); - ZoneOffset offset = rules.getOffset(instant); - long epochSec = instant.getEpochSecond() + offset.getTotalSeconds(); // overflow caught later - long epochDay = Math.floorDiv(epochSec, SECONDS_PER_DAY); - LocalDate date = LocalDate.ofEpochDay(epochDay); - return new OffsetDate(date, offset); - } - - //----------------------------------------------------------------------- - /** - * Obtains an instance of {@code OffsetDate} from a temporal object. - *
- * A {@code TemporalAccessor} represents some form of date and time information. - * This factory converts the arbitrary temporal object to an instance of {@code OffsetDate}. - *
- * The conversion extracts and combines {@code LocalDate} and {@code ZoneOffset}. - *
- * This method matches the signature of the functional interface {@link TemporalQuery} - * allowing it to be used in queries via method reference, {@code OffsetDate::from}. - * - * @param temporal the temporal object to convert, not null - * @return the offset date, not null - * @throws DateTimeException if unable to convert to an {@code OffsetDate} - */ - public static OffsetDate from(TemporalAccessor temporal) { - if (temporal instanceof OffsetDate) { - return (OffsetDate) temporal; - } - try { - LocalDate date = LocalDate.from(temporal); - ZoneOffset offset = ZoneOffset.from(temporal); - return new OffsetDate(date, offset); - } catch (DateTimeException ex) { - throw new DateTimeException("Unable to obtain OffsetDate from TemporalAccessor: " + temporal.getClass(), ex); - } - } - - //----------------------------------------------------------------------- - /** - * Obtains an instance of {@code OffsetDate} from a text string such as {@code 2007-12-03+01:00}. - *
- * The string must represent a valid date and is parsed using - * {@link java.time.format.DateTimeFormatters#isoOffsetDate()}. - * - * @param text the text to parse such as "2007-12-03+01:00", not null - * @return the parsed offset date, not null - * @throws DateTimeParseException if the text cannot be parsed - */ - public static OffsetDate parse(CharSequence text) { - return parse(text, DateTimeFormatters.isoOffsetDate()); - } - - /** - * Obtains an instance of {@code OffsetDate} from a text string using a specific formatter. - *
- * The text is parsed using the formatter, returning a date. - * - * @param text the text to parse, not null - * @param formatter the formatter to use, not null - * @return the parsed offset date, not null - * @throws DateTimeParseException if the text cannot be parsed - */ - public static OffsetDate parse(CharSequence text, DateTimeFormatter formatter) { - Objects.requireNonNull(formatter, "formatter"); - return formatter.parse(text, OffsetDate::from); - } - - //----------------------------------------------------------------------- - /** - * Constructor. - * - * @param date the local date, not null - * @param offset the zone offset, not null - */ - private OffsetDate(LocalDate date, ZoneOffset offset) { - this.date = Objects.requireNonNull(date, "date"); - this.offset = Objects.requireNonNull(offset, "offset"); - } - - /** - * Returns a new date based on this one, returning {@code this} where possible. - * - * @param date the date to create with, not null - * @param offset the zone offset to create with, not null - */ - private OffsetDate with(LocalDate date, ZoneOffset offset) { - if (this.date == date && this.offset.equals(offset)) { - return this; - } - return new OffsetDate(date, offset); - } - - //----------------------------------------------------------------------- - /** - * Checks if the specified field is supported. - *
- * This checks if this date can be queried for the specified field. - * If false, then calling the {@link #range(TemporalField) range} and - * {@link #get(TemporalField) get} methods will throw an exception. - *
- * If the field is a {@link ChronoField} then the query is implemented here. - * The {@link #isSupported(TemporalField) supported fields} will return valid - * values based on this date-time. - * The supported fields are: - *
- * If the field is not a {@code ChronoField}, then the result of this method - * is obtained by invoking {@code TemporalField.doIsSupported(TemporalAccessor)} - * passing {@code this} as the argument. - * Whether the field is supported is determined by the field. - * - * @param field the field to check, null returns false - * @return true if the field is supported on this date, false if not - */ - @Override - public boolean isSupported(TemporalField field) { - if (field instanceof ChronoField) { - return ((ChronoField) field).isDateField() || field == OFFSET_SECONDS; - } - return field != null && field.doIsSupported(this); - } - - /** - * 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 {@link ChronoField} then the query is implemented here. - * The {@link #isSupported(TemporalField) supported fields} will return - * appropriate range instances. - * All other {@code ChronoField} instances will throw a {@code DateTimeException}. - *
- * If the field is not a {@code ChronoField}, then the result of this method - * is obtained by invoking {@code TemporalField.doRange(TemporalAccessor)} - * passing {@code this} as the argument. - * Whether the range can be obtained is determined by the field. - * - * @param field the field to query the range for, not null - * @return the range of valid values for the field, not null - * @throws DateTimeException if the range for the field cannot be obtained - */ - @Override - public ValueRange range(TemporalField field) { - if (field instanceof ChronoField) { - if (field == OFFSET_SECONDS) { - return field.range(); - } - return date.range(field); - } - return field.doRange(this); - } - - /** - * Gets the value of the specified field from this date as an {@code 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 {@link ChronoField} then the query is implemented here. - * The {@link #isSupported(TemporalField) supported fields} will return valid - * values based on this date, except {@code EPOCH_DAY} and {@code EPOCH_MONTH} - * which are too large to fit in an {@code int} and throw a {@code DateTimeException}. - * All other {@code ChronoField} instances will throw a {@code DateTimeException}. - *
- * If the field is not a {@code ChronoField}, then the result of this method - * is obtained by invoking {@code TemporalField.doGet(TemporalAccessor)} - * passing {@code this} as the argument. Whether the value can be obtained, - * and what the value represents, is determined by the field. - * - * @param field the field to get, not null - * @return the value for the field - * @throws DateTimeException if a value for the field cannot be obtained - * @throws ArithmeticException if numeric overflow occurs - */ - @Override // override for Javadoc - public int get(TemporalField field) { - return Temporal.super.get(field); - } - - /** - * Gets the value of the specified field from this date as a {@code 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 {@link ChronoField} then the query is implemented here. - * The {@link #isSupported(TemporalField) supported fields} will return valid - * values based on this date. - * All other {@code ChronoField} instances will throw a {@code DateTimeException}. - *
- * If the field is not a {@code ChronoField}, then the result of this method - * is obtained by invoking {@code TemporalField.doGet(TemporalAccessor)} - * passing {@code this} as the argument. Whether the value can be obtained, - * and what the value represents, is determined by the field. - * - * @param field the field to get, not null - * @return the value for the field - * @throws DateTimeException if a value for the field cannot be obtained - * @throws ArithmeticException if numeric overflow occurs - */ - @Override - public long getLong(TemporalField field) { - if (field instanceof ChronoField) { - if (field == OFFSET_SECONDS) { - return getOffset().getTotalSeconds(); - } - return date.getLong(field); - } - return field.doGet(this); - } - - //----------------------------------------------------------------------- - /** - * Gets the zone offset, such as '+01:00'. - *
- * This is the offset of the local date from UTC/Greenwich. - * - * @return the zone offset, not null - */ - public ZoneOffset getOffset() { - return offset; - } - - /** - * Returns a copy of this {@code OffsetDate} with the specified offset. - *
- * This method returns an object with the same {@code LocalDate} and the specified {@code ZoneOffset}. - * No calculation is needed or performed. - * For example, if this time represents {@code 2007-12-03+02:00} and the offset specified is - * {@code +03:00}, then this method will return {@code 2007-12-03+03:00}. - *
- * This instance is immutable and unaffected by this method call. - * - * @param offset the zone offset to change to, not null - * @return an {@code OffsetDate} based on this date with the requested offset, not null - */ - public OffsetDate withOffset(ZoneOffset offset) { - Objects.requireNonNull(offset, "offset"); - return with(date, offset); - } - - //----------------------------------------------------------------------- - /** - * Gets the {@code LocalDate} part of this date-time. - *
- * This returns a {@code LocalDate} with the same year, month and day - * as this date-time. - * - * @return the date part of this date-time, not null - */ - public LocalDate getDate() { - return date; - } - - //----------------------------------------------------------------------- - /** - * Gets the year field. - *
- * This method returns the primitive {@code int} value for the year. - *
- * The year returned by this method is proleptic as per {@code get(YEAR)}. - * To obtain the year-of-era, use {@code get(YEAR_OF_ERA}. - * - * @return the year, from MIN_YEAR to MAX_YEAR - */ - public int getYear() { - return date.getYear(); - } - - /** - * Gets the month-of-year field from 1 to 12. - *
- * This method returns the month as an {@code int} from 1 to 12. - * Application code is frequently clearer if the enum {@link Month} - * is used by calling {@link #getMonth()}. - * - * @return the month-of-year, from 1 to 12 - * @see #getMonth() - */ - public int getMonthValue() { - return date.getMonthValue(); - } - - /** - * Gets the month-of-year field using the {@code Month} enum. - *
- * This method returns the enum {@link Month} for the month. - * This avoids confusion as to what {@code int} values mean. - * If you need access to the primitive {@code int} value then the enum - * provides the {@link Month#getValue() int value}. - * - * @return the month-of-year, not null - * @see #getMonthValue() - */ - public Month getMonth() { - return date.getMonth(); - } - - /** - * Gets the day-of-month field. - *
- * This method returns the primitive {@code int} value for the day-of-month. - * - * @return the day-of-month, from 1 to 31 - */ - public int getDayOfMonth() { - return date.getDayOfMonth(); - } - - /** - * Gets the day-of-year field. - *
- * This method returns the primitive {@code int} value for the day-of-year. - * - * @return the day-of-year, from 1 to 365, or 366 in a leap year - */ - public int getDayOfYear() { - return date.getDayOfYear(); - } - - /** - * Gets the day-of-week field, which is an enum {@code DayOfWeek}. - *
- * This method returns the enum {@link java.time.DayOfWeek} for the day-of-week. - * This avoids confusion as to what {@code int} values mean. - * If you need access to the primitive {@code int} value then the enum - * provides the {@link java.time.DayOfWeek#getValue() int value}. - *
- * Additional information can be obtained from the {@code DayOfWeek}. - * This includes textual names of the values. - * - * @return the day-of-week, not null - */ - public DayOfWeek getDayOfWeek() { - return date.getDayOfWeek(); - } - - //----------------------------------------------------------------------- - /** - * Returns an adjusted copy of this date. - *
- * This returns a new {@code 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 {@link java.time.temporal.Adjusters}. - * These include finding the "last day of the month" and "next Wednesday". - * Key date-time classes also implement the {@code TemporalAdjuster} interface, - * such as {@link Month} and {@link java.time.temporal.MonthDay 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 {@link LocalDate} and {@link ZoneOffset} implement {@code 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 - * {@link TemporalAdjuster#adjustInto(Temporal)} method on the - * specified adjuster passing {@code this} as the argument. - *
- * This instance is immutable and unaffected by this method call. - * - * @param adjuster the adjuster to use, not null - * @return an {@code OffsetDate} based on {@code this} with the adjustment made, not null - * @throws DateTimeException if the adjustment cannot be made - * @throws ArithmeticException if numeric overflow occurs - */ - @Override - public OffsetDate with(TemporalAdjuster adjuster) { - // optimizations - if (adjuster instanceof LocalDate) { - return with((LocalDate) adjuster, offset); - } else if (adjuster instanceof ZoneOffset) { - return with(date, (ZoneOffset) adjuster); - } else if (adjuster instanceof OffsetDate) { - return (OffsetDate) adjuster; - } - return (OffsetDate) adjuster.adjustInto(this); - } - - /** - * Returns a copy of this date with the specified field set to a new value. - *
- * This returns a new {@code 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 {@link ChronoField} then the adjustment is implemented here. - *
- * The {@code 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 {@code DateTimeException} will be thrown. - *
- * The other {@link #isSupported(TemporalField) supported fields} will behave as per - * the matching method on {@link LocalDate#with(TemporalField, long)} LocalDate}. - * In this case, the offset is not part of the calculation and will be unchanged. - *
- * All other {@code ChronoField} instances will throw a {@code DateTimeException}. - *
- * If the field is not a {@code ChronoField}, then the result of this method - * is obtained by invoking {@code TemporalField.doWith(Temporal, long)} - * passing {@code 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. - * - * @param field the field to set in the result, not null - * @param newValue the new value of the field in the result - * @return an {@code OffsetDate} based on {@code this} with the specified field set, not null - * @throws DateTimeException if the field cannot be set - * @throws ArithmeticException if numeric overflow occurs - */ - @Override - public OffsetDate with(TemporalField field, long newValue) { - if (field instanceof ChronoField) { - if (field == OFFSET_SECONDS) { - ChronoField f = (ChronoField) field; - return with(date, ZoneOffset.ofTotalSeconds(f.checkValidIntValue(newValue))); - } - return with(date.with(field, newValue), offset); - } - return field.doWith(this, newValue); - } - - //----------------------------------------------------------------------- - /** - * Returns a copy of this {@code 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. - * - * @param year the year to set in the result, from MIN_YEAR to MAX_YEAR - * @return an {@code OffsetDate} based on this date with the requested year, not null - * @throws DateTimeException if the year value is invalid - */ - public OffsetDate withYear(int year) { - return with(date.withYear(year), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param month the month-of-year to set in the result, from 1 (January) to 12 (December) - * @return an {@code OffsetDate} based on this date with the requested month, not null - * @throws DateTimeException if the month-of-year value is invalid - */ - public OffsetDate withMonth(int month) { - return with(date.withMonth(month), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param dayOfMonth the day-of-month to set in the result, from 1 to 28-31 - * @return an {@code OffsetDate} based on this date with the requested day, not null - * @throws DateTimeException if the day-of-month value is invalid - * @throws DateTimeException if the day-of-month is invalid for the month-year - */ - public OffsetDate withDayOfMonth(int dayOfMonth) { - return with(date.withDayOfMonth(dayOfMonth), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param dayOfYear the day-of-year to set in the result, from 1 to 365-366 - * @return an {@code OffsetDate} based on this date with the requested day, not null - * @throws DateTimeException if the day-of-year value is invalid - * @throws DateTimeException if the day-of-year is invalid for the year - */ - public OffsetDate withDayOfYear(int dayOfYear) { - return with(date.withDayOfYear(dayOfYear), offset); - } - - //----------------------------------------------------------------------- - /** - * 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 {@link java.time.Period} but may be any other type implementing - * the {@link TemporalAdder} interface. - * The calculation is delegated to the specified adjuster, which typically calls - * back to {@link #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. - * - * @param adder the adder to use, not null - * @return an {@code OffsetDate} based on this date with the addition made, not null - * @throws DateTimeException if the addition cannot be made - * @throws ArithmeticException if numeric overflow occurs - */ - @Override - public OffsetDate plus(TemporalAdder adder) { - return (OffsetDate) adder.addTo(this); - } - - /** - * 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. - * - * @param amountToAdd the amount of the unit to add to the result, may be negative - * @param unit the unit of the period to add, not null - * @return an {@code OffsetDate} based on this date with the specified period added, not null - * @throws DateTimeException if the unit cannot be added to this type - */ - @Override - public OffsetDate plus(long amountToAdd, TemporalUnit unit) { - if (unit instanceof ChronoUnit) { - return with(date.plus(amountToAdd, unit), offset); - } - return unit.doPlus(this, amountToAdd); - } - - //----------------------------------------------------------------------- - /** - * Returns a copy of this {@code 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. - * - * @param years the years to add, may be negative - * @return an {@code OffsetDate} based on this date with the years added, not null - * @throws DateTimeException if the result exceeds the supported date range - */ - public OffsetDate plusYears(long years) { - return with(date.plusYears(years), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param months the months to add, may be negative - * @return an {@code OffsetDate} based on this date with the months added, not null - * @throws DateTimeException if the result exceeds the supported date range - */ - public OffsetDate plusMonths(long months) { - return with(date.plusMonths(months), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param weeks the weeks to add, may be negative - * @return an {@code OffsetDate} based on this date with the weeks added, not null - * @throws DateTimeException if the result exceeds the supported date range - */ - public OffsetDate plusWeeks(long weeks) { - return with(date.plusWeeks(weeks), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param days the days to add, may be negative - * @return an {@code OffsetDate} based on this date with the days added, not null - * @throws DateTimeException if the result exceeds the supported date range - */ - public OffsetDate plusDays(long days) { - return with(date.plusDays(days), offset); - } - - //----------------------------------------------------------------------- - /** - * 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 {@link java.time.Period} but may be any other type implementing - * the {@link TemporalSubtractor} interface. - * The calculation is delegated to the specified adjuster, which typically calls - * back to {@link #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. - * - * @param subtractor the subtractor to use, not null - * @return an {@code OffsetDate} based on this date with the subtraction made, not null - * @throws DateTimeException if the subtraction cannot be made - * @throws ArithmeticException if numeric overflow occurs - */ - @Override - public OffsetDate minus(TemporalSubtractor subtractor) { - return (OffsetDate) subtractor.subtractFrom(this); - } - - /** - * 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. - * - * @param amountToSubtract the amount of the unit to subtract from the result, may be negative - * @param unit the unit of the period to subtract, not null - * @return an {@code OffsetDate} based on this date with the specified period subtracted, not null - * @throws DateTimeException if the unit cannot be added to this type - */ - @Override - public OffsetDate minus(long amountToSubtract, TemporalUnit unit) { - return (amountToSubtract == Long.MIN_VALUE ? plus(Long.MAX_VALUE, unit).plus(1, unit) : plus(-amountToSubtract, unit)); - } - - //----------------------------------------------------------------------- - /** - * Returns a copy of this {@code 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. - * - * @param years the years to subtract, may be negative - * @return an {@code OffsetDate} based on this date with the years subtracted, not null - * @throws DateTimeException if the result exceeds the supported date range - */ - public OffsetDate minusYears(long years) { - return with(date.minusYears(years), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param months the months to subtract, may be negative - * @return an {@code OffsetDate} based on this date with the months subtracted, not null - * @throws DateTimeException if the result exceeds the supported date range - */ - public OffsetDate minusMonths(long months) { - return with(date.minusMonths(months), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param weeks the weeks to subtract, may be negative - * @return an {@code OffsetDate} based on this date with the weeks subtracted, not null - * @throws DateTimeException if the result exceeds the supported date range - */ - public OffsetDate minusWeeks(long weeks) { - return with(date.minusWeeks(weeks), offset); - } - - /** - * Returns a copy of this {@code 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. - * - * @param days the days to subtract, may be negative - * @return an {@code OffsetDate} based on this date with the days subtracted, not null - * @throws DateTimeException if the result exceeds the supported date range - */ - public OffsetDate minusDays(long days) { - return with(date.minusDays(days), offset); - } - - //----------------------------------------------------------------------- - /** - * Queries this date using the specified query. - *
- * This queries this date using the specified query strategy object. - * The {@code 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
- * {@link TemporalQuery#queryFrom(TemporalAccessor)} method on the
- * specified query passing {@code this} as the argument.
- *
- * @param
- * 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 {@link Temporal#with(TemporalField, long)}
- * twice, passing {@link ChronoField#OFFSET_SECONDS} and
- * {@link ChronoField#EPOCH_DAY} as the fields.
- *
- * In most cases, it is clearer to reverse the calling pattern by using
- * {@link Temporal#with(TemporalAdjuster)}:
- *
- * This instance is immutable and unaffected by this method call.
- *
- * @param temporal the target object to be adjusted, not null
- * @return the adjusted object, not null
- * @throws DateTimeException if unable to make the adjustment
- * @throws ArithmeticException if numeric overflow occurs
- */
- @Override
- public Temporal adjustInto(Temporal temporal) {
- return temporal
- .with(OFFSET_SECONDS, getOffset().getTotalSeconds())
- .with(EPOCH_DAY, getDate().toEpochDay());
- }
-
- /**
- * 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 {@code 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 {@code startDate.periodUntil(endDate, DAYS)}.
- *
- * The {@code Temporal} passed to this method must be an {@code 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 {@link TemporalUnit#between}.
- * The result of this method is a {@code long} representing the amount of
- * the specified unit. By contrast, the result of {@code between} is an
- * object that can be used directly in addition/subtraction:
- *
- * The calculation is implemented in this method for {@link ChronoUnit}.
- * The units {@code DAYS}, {@code WEEKS}, {@code MONTHS}, {@code YEARS},
- * {@code DECADES}, {@code CENTURIES}, {@code MILLENNIA} and {@code ERAS}
- * are supported. Other {@code ChronoUnit} values will throw an exception.
- *
- * If the unit is not a {@code ChronoUnit}, then the result of this method
- * is obtained by invoking {@code TemporalUnit.between(Temporal, Temporal)}
- * passing {@code this} as the first argument and the input temporal as
- * the second argument.
- *
- * This instance is immutable and unaffected by this method call.
- *
- * @param endDate the end date, which must be an {@code OffsetDate}, not null
- * @param unit the unit to measure the period in, not null
- * @return the amount of the period between this date and the end date
- * @throws DateTimeException if the period cannot be calculated
- * @throws ArithmeticException if numeric overflow occurs
- */
- @Override
- public long periodUntil(Temporal endDate, TemporalUnit unit) {
- if (endDate instanceof OffsetDate == false) {
- Objects.requireNonNull(endDate, "endDate");
- throw new DateTimeException("Unable to calculate period between objects of two different types");
- }
- if (unit instanceof ChronoUnit) {
- OffsetDate end = (OffsetDate) endDate;
- long offsetDiff = end.offset.getTotalSeconds() - offset.getTotalSeconds();
- LocalDate endLocal = end.date.plusDays(Math.floorDiv(-offsetDiff, SECONDS_PER_DAY));
- return date.periodUntil(endLocal, unit);
- }
- return unit.between(this, endDate).getAmount();
- }
-
- //-----------------------------------------------------------------------
- /**
- * Returns an offset date-time formed from this date at the specified time.
- *
- * This combines this date with the specified time to form an {@code OffsetDateTime}.
- * All possible combinations of date and time are valid.
- *
- * This instance is immutable and unaffected by this method call.
- *
- * @param time the time to combine with, not null
- * @return the offset date-time formed from this date and the specified time, not null
- */
- public OffsetDateTime atTime(LocalTime time) {
- return OffsetDateTime.of(date, time, offset);
- }
-
- //-----------------------------------------------------------------------
- /**
- * Converts this date to midnight at the start of day in epoch seconds.
- *
- * @return the epoch seconds value
- */
- private long toEpochSecond() {
- long epochDay = date.toEpochDay();
- long secs = epochDay * SECONDS_PER_DAY;
- return secs - offset.getTotalSeconds();
- }
-
- //-----------------------------------------------------------------------
- /**
- * Compares this {@code 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 {@link Comparable}.
- *
- * For example, the following is the comparator order:
- *
- * To compare the underlying local date of two {@code TemporalAccessor} instances,
- * use {@link ChronoField#EPOCH_DAY} as a comparator.
- *
- * @param other the other date to compare to, not null
- * @return the comparator value, negative if less, positive if greater
- */
- @Override
- public int compareTo(OffsetDate other) {
- if (offset.equals(other.offset)) {
- return date.compareTo(other.date);
- }
- int compare = Long.compare(toEpochSecond(), other.toEpochSecond());
- if (compare == 0) {
- compare = date.compareTo(other.date);
- }
- return compare;
- }
-
- //-----------------------------------------------------------------------
- /**
- * Checks if the instant of midnight at the start of this {@code OffsetDate}
- * is after midnight at the start of the specified date.
- *
- * This method differs from the comparison in {@link #compareTo} in that it
- * only compares the instant of the date. This is equivalent to using
- * {@code date1.toEpochSecond().isAfter(date2.toEpochSecond())}.
- *
- * @param other the other date to compare to, not null
- * @return true if this is after the instant of the specified date
- */
- public boolean isAfter(OffsetDate other) {
- return toEpochSecond() > other.toEpochSecond();
- }
-
- /**
- * Checks if the instant of midnight at the start of this {@code OffsetDate}
- * is before midnight at the start of the specified date.
- *
- * This method differs from the comparison in {@link #compareTo} in that it
- * only compares the instant of the date. This is equivalent to using
- * {@code date1.toEpochSecond().isBefore(date2.toEpochSecond())}.
- *
- * @param other the other date to compare to, not null
- * @return true if this is before the instant of the specified date
- */
- public boolean isBefore(OffsetDate other) {
- return toEpochSecond() < other.toEpochSecond();
- }
-
- /**
- * Checks if the instant of midnight at the start of this {@code OffsetDate}
- * equals midnight at the start of the specified date.
- *
- * This method differs from the comparison in {@link #compareTo} and {@link #equals}
- * in that it only compares the instant of the date. This is equivalent to using
- * {@code date1.toEpochSecond().equals(date2.toEpochSecond())}.
- *
- * @param other the other date to compare to, not null
- * @return true if the instant equals the instant of the specified date
- */
- public boolean isEqual(OffsetDate other) {
- return toEpochSecond() == other.toEpochSecond();
- }
-
- //-----------------------------------------------------------------------
- /**
- * 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 {@link #isEqual(OffsetDate)}.
- *
- * Only objects of type {@code OffsetDate} are compared, other types return false.
- * To compare the underlying local date of two {@code TemporalAccessor} instances,
- * use {@link ChronoField#EPOCH_DAY} as a comparator.
- *
- * @param obj the object to check, null returns false
- * @return true if this is equal to the other date
- */
- @Override
- public boolean equals(Object obj) {
- if (this == obj) {
- return true;
- }
- if (obj instanceof OffsetDate) {
- OffsetDate other = (OffsetDate) obj;
- return date.equals(other.date) && offset.equals(other.offset);
- }
- return false;
- }
-
- /**
- * A hash code for this date.
- *
- * @return a suitable hash code
- */
- @Override
- public int hashCode() {
- return date.hashCode() ^ offset.hashCode();
- }
-
- //-----------------------------------------------------------------------
- /**
- * Outputs this date as a {@code String}, such as {@code 2007-12-03+01:00}.
- *
- * The output will be in the ISO-8601 format {@code yyyy-MM-ddXXXXX}.
- *
- * @return a string representation of this date, not null
- */
- @Override
- public String toString() {
- return date.toString() + offset.toString();
- }
-
- /**
- * Outputs this date as a {@code String} using the formatter.
- *
- * This date will be passed to the formatter
- * {@link DateTimeFormatter#print(TemporalAccessor) print method}.
- *
- * @param formatter the formatter to use, not null
- * @return the formatted date string, not null
- * @throws DateTimeException if an error occurs during printing
- */
- public String toString(DateTimeFormatter formatter) {
- Objects.requireNonNull(formatter, "formatter");
- return formatter.print(this);
- }
-
- //-----------------------------------------------------------------------
- /**
- * Writes the object using a
- * dedicated serialized form.
- *
- * // these two lines are equivalent, but the second approach is recommended
- * temporal = thisOffsetDate.adjustInto(temporal);
- * temporal = temporal.with(thisOffsetDate);
- *
- *
- * long period = start.periodUntil(end, MONTHS); // this method
- * dateTime.plus(MONTHS.between(start, end)); // use in plus/minus
- *
- *
- *
- * 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 {@code equals()}.
- *
- * out.writeByte(1); // identifies this as a OffsetDateTime
- * out.writeObject(date);
- * out.writeObject(offset);
- *
- *
- * @return the instance of {@code Ser}, not null
- */
- private Object writeReplace() {
- return new Ser(Ser.OFFSET_DATE_TYPE, this);
- }
-
- /**
- * Defend against malicious streams.
- * @return never
- * @throws InvalidObjectException always
- */
- private Object readResolve() throws ObjectStreamException {
- throw new InvalidObjectException("Deserialization via serialization delegate");
- }
-
- void writeExternal(ObjectOutput out) throws IOException {
- out.writeObject(date);
- out.writeObject(offset);
- }
-
- static OffsetDate readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
- LocalDate date = (LocalDate) in.readObject();
- ZoneOffset offset = (ZoneOffset) in.readObject();
- return OffsetDate.of(date, offset);
- }
-
-}