1c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer/* 2c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved. 3c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 5c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This code is free software; you can redistribute it and/or modify it 6c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * under the terms of the GNU General Public License version 2 only, as 7c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * published by the Free Software Foundation. Oracle designates this 8c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * particular file as subject to the "Classpath" exception as provided 9c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * by Oracle in the LICENSE file that accompanied this code. 10c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 11c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This code is distributed in the hope that it will be useful, but WITHOUT 12c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * version 2 for more details (a copy is included in the LICENSE file that 15c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * accompanied this code). 16c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 17c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * You should have received a copy of the GNU General Public License version 18c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 2 along with this work; if not, write to the Free Software Foundation, 19c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 21c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * or visit www.oracle.com if you need additional information or have any 23c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * questions. 24c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 25c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 26c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer/* 27c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This file is available under and governed by the GNU General Public 28c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * License version 2 only, as published by the Free Software Foundation. 29c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * However, the following notice accompanied the original version of this 30c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * file: 31c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 32c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Copyright (c) 2008-2012, Stephen Colebourne & Michael Nascimento Santos 33c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 34c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * All rights reserved. 35c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 36c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Redistribution and use in source and binary forms, with or without 37c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * modification, are permitted provided that the following conditions are met: 38c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 39c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * * Redistributions of source code must retain the above copyright notice, 40c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * this list of conditions and the following disclaimer. 41c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 42c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * * Redistributions in binary form must reproduce the above copyright notice, 43c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * this list of conditions and the following disclaimer in the documentation 44c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * and/or other materials provided with the distribution. 45c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 46c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * * Neither the name of JSR-310 nor the names of its contributors 47c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * may be used to endorse or promote products derived from this software 48c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * without specific prior written permission. 49c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 50c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 51c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 52c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 53c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 54c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 55c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 56c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 57c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 58c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 59c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 60c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 61c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 62c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerpackage java.time; 63c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 64c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport static java.time.temporal.ChronoUnit.DAYS; 65c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport static java.time.temporal.ChronoUnit.MONTHS; 66c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport static java.time.temporal.ChronoUnit.YEARS; 67c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 68c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.io.DataInput; 69c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.io.DataOutput; 70c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.io.IOException; 71c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.io.InvalidObjectException; 72c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.io.ObjectInputStream; 73c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.io.Serializable; 74c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.chrono.ChronoLocalDate; 75c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.chrono.ChronoPeriod; 76c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.chrono.Chronology; 77c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.chrono.IsoChronology; 78c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.format.DateTimeParseException; 79c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.temporal.ChronoUnit; 80c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.temporal.Temporal; 81c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.temporal.TemporalAccessor; 82c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.temporal.TemporalAmount; 83c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.temporal.TemporalQueries; 84c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.temporal.TemporalUnit; 85c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.time.temporal.UnsupportedTemporalTypeException; 86c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.util.Arrays; 87c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.util.Collections; 88c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.util.List; 89c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.util.Objects; 90c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.util.regex.Matcher; 91c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerimport java.util.regex.Pattern; 92c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 9369fc4ab478c65571e31c4156c4cff998cef4ececPrzemyslaw Szczepaniak// Android-changed: removed ValueBased paragraph. 94c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer/** 95c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * A date-based amount of time in the ISO-8601 calendar system, 96c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * such as '2 years, 3 months and 4 days'. 97c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 98c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This class models a quantity or amount of time in terms of years, months and days. 99c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * See {@link Duration} for the time-based equivalent to this class. 100c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 101c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Durations and periods differ in their treatment of daylight savings time 102c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * when added to {@link ZonedDateTime}. A {@code Duration} will add an exact 103c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * number of seconds, thus a duration of one day is always exactly 24 hours. 104c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * By contrast, a {@code Period} will add a conceptual day, trying to maintain 105c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * the local time. 106c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 107c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, consider adding a period of one day and a duration of one day to 108c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 18:00 on the evening before a daylight savings gap. The {@code Period} will add 109c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * the conceptual day and result in a {@code ZonedDateTime} at 18:00 the following day. 110c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * By contrast, the {@code Duration} will add exactly 24 hours, resulting in a 111c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * {@code ZonedDateTime} at 19:00 the following day (assuming a one hour DST gap). 112c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 113c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The supported units of a period are {@link ChronoUnit#YEARS YEARS}, 114c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * {@link ChronoUnit#MONTHS MONTHS} and {@link ChronoUnit#DAYS DAYS}. 115c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * All three fields are always present, but may be set to zero. 116c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 117c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The ISO-8601 calendar system is the modern civil calendar system used today 118c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * in most of the world. It is equivalent to the proleptic Gregorian calendar 119c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * system, in which today's rules for leap years are applied for all time. 120c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 121c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The period is modeled as a directed amount of time, meaning that individual parts of the 122c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * period may be negative. 123c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 124c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @implSpec 125c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This class is immutable and thread-safe. 126c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 127c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @since 1.8 128c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 129c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauerpublic final class Period 130c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer implements ChronoPeriod, Serializable { 131c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 132c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 133c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * A constant for a period of zero. 134c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 135c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static final Period ZERO = new Period(0, 0, 0); 136c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 137c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Serialization version. 138c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 139c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private static final long serialVersionUID = -3587258372562876L; 140c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 141c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The pattern for parsing. 142c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 143c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private static final Pattern PATTERN = 144c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Pattern.compile("([-+]?)P(?:([-+]?[0-9]+)Y)?(?:([-+]?[0-9]+)M)?(?:([-+]?[0-9]+)W)?(?:([-+]?[0-9]+)D)?", Pattern.CASE_INSENSITIVE); 145c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 146c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 147c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The set of supported units. 148c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 149c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private static final List<TemporalUnit> SUPPORTED_UNITS = 150c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Collections.unmodifiableList(Arrays.<TemporalUnit>asList(YEARS, MONTHS, DAYS)); 151c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 152c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 153c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The number of years. 154c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 155c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private final int years; 156c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 157c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The number of months. 158c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 159c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private final int months; 160c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 161c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The number of days. 162c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 163c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private final int days; 164c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 165c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 166c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 167c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Obtains a {@code Period} representing a number of years. 168c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 169c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The resulting period will have the specified years. 170c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months and days units will be zero. 171c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 172c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param years the number of years, positive or negative 173c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the period of years, not null 174c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 175c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static Period ofYears(int years) { 176c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, 0, 0); 177c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 178c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 179c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 180c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Obtains a {@code Period} representing a number of months. 181c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 182c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The resulting period will have the specified months. 183c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and days units will be zero. 184c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 185c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param months the number of months, positive or negative 186c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the period of months, not null 187c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 188c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static Period ofMonths(int months) { 189c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(0, months, 0); 190c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 191c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 192c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 193c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Obtains a {@code Period} representing a number of weeks. 194c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 195c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The resulting period will be day-based, with the amount of days 196c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * equal to the number of weeks multiplied by 7. 197c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and months units will be zero. 198c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 199c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param weeks the number of weeks, positive or negative 200c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the period, with the input weeks converted to days, not null 201c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 202c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static Period ofWeeks(int weeks) { 203c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(0, 0, Math.multiplyExact(weeks, 7)); 204c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 205c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 206c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 207c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Obtains a {@code Period} representing a number of days. 208c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 209c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The resulting period will have the specified days. 210c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and months units will be zero. 211c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 212c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param days the number of days, positive or negative 213c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the period of days, not null 214c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 215c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static Period ofDays(int days) { 216c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(0, 0, days); 217c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 218c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 219c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 220c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 221c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Obtains a {@code Period} representing a number of years, months and days. 222c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 223c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This creates an instance based on years, months and days. 224c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 225c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param years the amount of years, may be negative 226c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param months the amount of months, may be negative 227c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param days the amount of days, may be negative 228c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the period of years, months and days, not null 229c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 230c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static Period of(int years, int months, int days) { 231c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, months, days); 232c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 233c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 234c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 235c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 236c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Obtains an instance of {@code Period} from a temporal amount. 237c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 238c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This obtains a period based on the specified amount. 239c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * A {@code TemporalAmount} represents an amount of time, which may be 240c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * date-based or time-based, which this factory extracts to a {@code Period}. 241c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 242c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The conversion loops around the set of units from the amount and uses 243c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * the {@link ChronoUnit#YEARS YEARS}, {@link ChronoUnit#MONTHS MONTHS} 244c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * and {@link ChronoUnit#DAYS DAYS} units to create a period. 245c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * If any other units are found then an exception is thrown. 246c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 247c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * If the amount is a {@code ChronoPeriod} then it must use the ISO chronology. 248c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 249c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param amount the temporal amount to convert, not null 250c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the equivalent period, not null 251c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws DateTimeException if unable to convert to a {@code Period} 252c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if the amount of years, months or days exceeds an int 253c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 254c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static Period from(TemporalAmount amount) { 255c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (amount instanceof Period) { 256c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return (Period) amount; 257c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 258c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (amount instanceof ChronoPeriod) { 259c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (IsoChronology.INSTANCE.equals(((ChronoPeriod) amount).getChronology()) == false) { 260c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer throw new DateTimeException("Period requires ISO chronology: " + amount); 261c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 262c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 263c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Objects.requireNonNull(amount, "amount"); 264c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int years = 0; 265c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int months = 0; 266c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int days = 0; 267c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer for (TemporalUnit unit : amount.getUnits()) { 268c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer long unitAmount = amount.get(unit); 269c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (unit == ChronoUnit.YEARS) { 270c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer years = Math.toIntExact(unitAmount); 271c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else if (unit == ChronoUnit.MONTHS) { 272c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer months = Math.toIntExact(unitAmount); 273c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else if (unit == ChronoUnit.DAYS) { 274c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer days = Math.toIntExact(unitAmount); 275c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else { 276c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer throw new DateTimeException("Unit must be Years, Months or Days, but was " + unit); 277c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 278c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 279c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, months, days); 280c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 281c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 282c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 283c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 284c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Obtains a {@code Period} from a text string such as {@code PnYnMnD}. 285c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 286c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This will parse the string produced by {@code toString()} which is 287c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * based on the ISO-8601 period formats {@code PnYnMnD} and {@code PnW}. 288c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 289c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The string starts with an optional sign, denoted by the ASCII negative 290c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * or positive symbol. If negative, the whole period is negated. 291c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The ASCII letter "P" is next in upper or lower case. 292c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * There are then four sections, each consisting of a number and a suffix. 293c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * At least one of the four sections must be present. 294c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The sections have suffixes in ASCII of "Y", "M", "W" and "D" for 295c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * years, months, weeks and days, accepted in upper or lower case. 296c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The suffixes must occur in order. 297c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The number part of each section must consist of ASCII digits. 298c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The number may be prefixed by the ASCII negative or positive symbol. 299c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The number must parse to an {@code int}. 300c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 301c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The leading plus/minus sign, and negative values for other units are 302c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * not part of the ISO-8601 standard. In addition, ISO-8601 does not 303c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * permit mixing between the {@code PnYnMnD} and {@code PnW} formats. 304c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Any week-based input is multiplied by 7 and treated as a number of days. 305c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 306c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, the following are valid inputs: 307c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <pre> 308c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "P2Y" -- Period.ofYears(2) 309c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "P3M" -- Period.ofMonths(3) 310c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "P4W" -- Period.ofWeeks(4) 311c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "P5D" -- Period.ofDays(5) 312c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "P1Y2M3D" -- Period.of(1, 2, 3) 313c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "P1Y2M3W4D" -- Period.of(1, 2, 25) 314c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "P-1Y2M" -- Period.of(-1, 2, 0) 315c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "-P1Y2M" -- Period.of(-1, -2, 0) 316c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * </pre> 317c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 318c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param text the text to parse, not null 319c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the parsed period, not null 320c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws DateTimeParseException if the text cannot be parsed to a period 321c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 322c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static Period parse(CharSequence text) { 323c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Objects.requireNonNull(text, "text"); 324c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Matcher matcher = PATTERN.matcher(text); 325c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (matcher.matches()) { 326c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int negate = ("-".equals(matcher.group(1)) ? -1 : 1); 327c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer String yearMatch = matcher.group(2); 328c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer String monthMatch = matcher.group(3); 329c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer String weekMatch = matcher.group(4); 330c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer String dayMatch = matcher.group(5); 331c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (yearMatch != null || monthMatch != null || dayMatch != null || weekMatch != null) { 332c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer try { 333c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int years = parseNumber(text, yearMatch, negate); 334c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int months = parseNumber(text, monthMatch, negate); 335c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int weeks = parseNumber(text, weekMatch, negate); 336c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int days = parseNumber(text, dayMatch, negate); 337c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer days = Math.addExact(days, Math.multiplyExact(weeks, 7)); 338c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, months, days); 339c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } catch (NumberFormatException ex) { 340c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer throw new DateTimeParseException("Text cannot be parsed to a Period", text, 0, ex); 341c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 342c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 343c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 344c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer throw new DateTimeParseException("Text cannot be parsed to a Period", text, 0); 345c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 346c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 347c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private static int parseNumber(CharSequence text, String str, int negate) { 348c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (str == null) { 349c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return 0; 350c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 351c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int val = Integer.parseInt(str); 352c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer try { 353c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return Math.multiplyExact(val, negate); 354c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } catch (ArithmeticException ex) { 355c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer throw new DateTimeParseException("Text cannot be parsed to a Period", text, 0, ex); 356c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 357c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 358c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 359c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 360c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 361c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Obtains a {@code Period} consisting of the number of years, months, 362c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * and days between two dates. 363c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 364c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The start date is included, but the end date is not. 365c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The period is calculated by removing complete months, then calculating 366c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * the remaining number of days, adjusting to ensure that both have the same sign. 367c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The number of months is then split into years and months based on a 12 month year. 368c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * A month is considered if the end day-of-month is greater than or equal to the start day-of-month. 369c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, from {@code 2010-01-15} to {@code 2011-03-18} is one year, two months and three days. 370c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 371c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The result of this method can be a negative period if the end is before the start. 372c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The negative sign will be the same in each of year, month and day. 373c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 374c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param startDateInclusive the start date, inclusive, not null 375c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param endDateExclusive the end date, exclusive, not null 376c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the period between this date and the end date, not null 377c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @see ChronoLocalDate#until(ChronoLocalDate) 378c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 379c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public static Period between(LocalDate startDateInclusive, LocalDate endDateExclusive) { 380c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return startDateInclusive.until(endDateExclusive); 381c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 382c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 383c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 384c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 385c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Creates an instance. 386c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 387c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param years the amount 388c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param months the amount 389c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param days the amount 390c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 391c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private static Period create(int years, int months, int days) { 392c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if ((years | months | days) == 0) { 393c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return ZERO; 394c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 395c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return new Period(years, months, days); 396c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 397c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 398c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 399c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Constructor. 400c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 401c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param years the amount 402c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param months the amount 403c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param days the amount 404c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 405c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private Period(int years, int months, int days) { 406c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer this.years = years; 407c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer this.months = months; 408c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer this.days = days; 409c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 410c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 411c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 412c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 413c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Gets the value of the requested unit. 414c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 415c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns a value for each of the three supported units, 416c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * {@link ChronoUnit#YEARS YEARS}, {@link ChronoUnit#MONTHS MONTHS} and 417c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * {@link ChronoUnit#DAYS DAYS}. 418c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * All other units throw an exception. 419c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 420c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param unit the {@code TemporalUnit} for which to return the value 421c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the long value of the unit 422c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws DateTimeException if the unit is not supported 423c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws UnsupportedTemporalTypeException if the unit is not supported 424c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 425c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer @Override 426c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public long get(TemporalUnit unit) { 427c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (unit == ChronoUnit.YEARS) { 428c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return getYears(); 429c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else if (unit == ChronoUnit.MONTHS) { 430c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return getMonths(); 431c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else if (unit == ChronoUnit.DAYS) { 432c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return getDays(); 433c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else { 434c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer throw new UnsupportedTemporalTypeException("Unsupported unit: " + unit); 435c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 436c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 437c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 438c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 439c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Gets the set of units supported by this period. 440c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 441c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The supported units are {@link ChronoUnit#YEARS YEARS}, 442c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * {@link ChronoUnit#MONTHS MONTHS} and {@link ChronoUnit#DAYS DAYS}. 443c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * They are returned in the order years, months, days. 444c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 445c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This set can be used in conjunction with {@link #get(TemporalUnit)} 446c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * to access the entire state of the period. 447c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 448c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a list containing the years, months and days units, not null 449c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 450c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer @Override 451c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public List<TemporalUnit> getUnits() { 452c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return SUPPORTED_UNITS; 453c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 454c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 455c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 456c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Gets the chronology of this period, which is the ISO calendar system. 457c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 458c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The {@code Chronology} represents the calendar system in use. 459c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The ISO-8601 calendar system is the modern civil calendar system used today 460c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * in most of the world. It is equivalent to the proleptic Gregorian calendar 461c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * system, in which today's rules for leap years are applied for all time. 462c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 463c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the ISO chronology, not null 464c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 465c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer @Override 466c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public IsoChronology getChronology() { 467c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return IsoChronology.INSTANCE; 468c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 469c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 470c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 471c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 472c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Checks if all three units of this period are zero. 473c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 474c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * A zero period has the value zero for the years, months and days units. 475c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 476c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return true if this period is zero-length 477c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 478c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public boolean isZero() { 479c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return (this == ZERO); 480c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 481c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 482c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 483c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Checks if any of the three units of this period are negative. 484c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 485c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This checks whether the years, months or days units are less than zero. 486c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 487c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return true if any unit of this period is negative 488c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 489c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public boolean isNegative() { 490c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return years < 0 || months < 0 || days < 0; 491c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 492c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 493c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 494c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 495c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Gets the amount of years of this period. 496c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 497c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns the years unit. 498c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 499c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months unit is not automatically normalized with the years unit. 500c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This means that a period of "15 months" is different to a period 501c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * of "1 year and 3 months". 502c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 503c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the amount of years of this period, may be negative 504c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 505c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public int getYears() { 506c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return years; 507c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 508c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 509c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 510c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Gets the amount of months of this period. 511c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 512c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns the months unit. 513c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 514c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months unit is not automatically normalized with the years unit. 515c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This means that a period of "15 months" is different to a period 516c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * of "1 year and 3 months". 517c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 518c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the amount of months of this period, may be negative 519c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 520c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public int getMonths() { 521c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return months; 522c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 523c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 524c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 525c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Gets the amount of days of this period. 526c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 527c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns the days unit. 528c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 529c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the amount of days of this period, may be negative 530c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 531c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public int getDays() { 532c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return days; 533c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 534c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 535c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 536c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 537c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified amount of years. 538c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 539c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This sets the amount of the years unit in a copy of this period. 540c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months and days units are unaffected. 541c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 542c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months unit is not automatically normalized with the years unit. 543c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This means that a period of "15 months" is different to a period 544c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * of "1 year and 3 months". 545c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 546c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 547c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 548c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param years the years to represent, may be negative 549c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the requested years, not null 550c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 551c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period withYears(int years) { 552c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (years == this.years) { 553c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return this; 554c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 555c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, months, days); 556c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 557c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 558c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 559c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified amount of months. 560c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 561c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This sets the amount of the months unit in a copy of this period. 562c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and days units are unaffected. 563c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 564c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months unit is not automatically normalized with the years unit. 565c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This means that a period of "15 months" is different to a period 566c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * of "1 year and 3 months". 567c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 568c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 569c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 570c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param months the months to represent, may be negative 571c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the requested months, not null 572c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 573c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period withMonths(int months) { 574c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (months == this.months) { 575c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return this; 576c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 577c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, months, days); 578c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 579c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 580c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 581c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified amount of days. 582c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 583c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This sets the amount of the days unit in a copy of this period. 584c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and months units are unaffected. 585c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 586c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 587c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 588c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param days the days to represent, may be negative 589c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the requested days, not null 590c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 591c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period withDays(int days) { 592c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (days == this.days) { 593c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return this; 594c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 595c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, months, days); 596c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 597c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 598c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 599c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 600c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified period added. 601c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 602c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This operates separately on the years, months and days. 603c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * No normalization is performed. 604c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 605c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, "1 year, 6 months and 3 days" plus "2 years, 2 months and 2 days" 606c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * returns "3 years, 8 months and 5 days". 607c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 608c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The specified amount is typically an instance of {@code Period}. 609c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Other types are interpreted using {@link Period#from(TemporalAmount)}. 610c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 611c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 612c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 613c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param amountToAdd the amount to add, not null 614c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the requested period added, not null 615c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws DateTimeException if the specified amount has a non-ISO chronology or 616c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * contains an invalid unit 617c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 618c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 619c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period plus(TemporalAmount amountToAdd) { 620c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Period isoAmount = Period.from(amountToAdd); 621c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create( 622c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.addExact(years, isoAmount.years), 623c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.addExact(months, isoAmount.months), 624c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.addExact(days, isoAmount.days)); 625c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 626c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 627c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 628c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified years added. 629c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 630c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This adds the amount to the years unit in a copy of this period. 631c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months and days units are unaffected. 632c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, "1 year, 6 months and 3 days" plus 2 years returns "3 years, 6 months and 3 days". 633c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 634c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 635c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 636c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param yearsToAdd the years to add, positive or negative 637c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the specified years added, not null 638c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 639c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 640c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period plusYears(long yearsToAdd) { 641c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (yearsToAdd == 0) { 642c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return this; 643c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 644c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(Math.toIntExact(Math.addExact(years, yearsToAdd)), months, days); 645c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 646c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 647c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 648c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified months added. 649c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 650c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This adds the amount to the months unit in a copy of this period. 651c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and days units are unaffected. 652c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, "1 year, 6 months and 3 days" plus 2 months returns "1 year, 8 months and 3 days". 653c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 654c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 655c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 656c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param monthsToAdd the months to add, positive or negative 657c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the specified months added, not null 658c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 659c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 660c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period plusMonths(long monthsToAdd) { 661c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (monthsToAdd == 0) { 662c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return this; 663c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 664c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, Math.toIntExact(Math.addExact(months, monthsToAdd)), days); 665c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 666c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 667c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 668c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified days added. 669c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 670c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This adds the amount to the days unit in a copy of this period. 671c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and months units are unaffected. 672c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, "1 year, 6 months and 3 days" plus 2 days returns "1 year, 6 months and 5 days". 673c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 674c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 675c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 676c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param daysToAdd the days to add, positive or negative 677c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the specified days added, not null 678c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 679c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 680c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period plusDays(long daysToAdd) { 681c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (daysToAdd == 0) { 682c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return this; 683c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 684c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(years, months, Math.toIntExact(Math.addExact(days, daysToAdd))); 685c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 686c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 687c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 688c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 689c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified period subtracted. 690c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 691c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This operates separately on the years, months and days. 692c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * No normalization is performed. 693c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 694c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, "1 year, 6 months and 3 days" minus "2 years, 2 months and 2 days" 695c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * returns "-1 years, 4 months and 1 day". 696c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 697c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The specified amount is typically an instance of {@code Period}. 698c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Other types are interpreted using {@link Period#from(TemporalAmount)}. 699c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 700c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 701c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 702c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param amountToSubtract the amount to subtract, not null 703c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the requested period subtracted, not null 704c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws DateTimeException if the specified amount has a non-ISO chronology or 705c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * contains an invalid unit 706c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 707c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 708c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period minus(TemporalAmount amountToSubtract) { 709c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Period isoAmount = Period.from(amountToSubtract); 710c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create( 711c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.subtractExact(years, isoAmount.years), 712c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.subtractExact(months, isoAmount.months), 713c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.subtractExact(days, isoAmount.days)); 714c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 715c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 716c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 717c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified years subtracted. 718c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 719c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This subtracts the amount from the years unit in a copy of this period. 720c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months and days units are unaffected. 721c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, "1 year, 6 months and 3 days" minus 2 years returns "-1 years, 6 months and 3 days". 722c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 723c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 724c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 725c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param yearsToSubtract the years to subtract, positive or negative 726c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the specified years subtracted, not null 727c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 728c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 729c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period minusYears(long yearsToSubtract) { 730c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return (yearsToSubtract == Long.MIN_VALUE ? plusYears(Long.MAX_VALUE).plusYears(1) : plusYears(-yearsToSubtract)); 731c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 732c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 733c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 734c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified months subtracted. 735c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 736c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This subtracts the amount from the months unit in a copy of this period. 737c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and days units are unaffected. 738c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, "1 year, 6 months and 3 days" minus 2 months returns "1 year, 4 months and 3 days". 739c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 740c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 741c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 742c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param monthsToSubtract the years to subtract, positive or negative 743c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the specified months subtracted, not null 744c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 745c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 746c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period minusMonths(long monthsToSubtract) { 747c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return (monthsToSubtract == Long.MIN_VALUE ? plusMonths(Long.MAX_VALUE).plusMonths(1) : plusMonths(-monthsToSubtract)); 748c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 749c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 750c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 751c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the specified days subtracted. 752c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 753c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This subtracts the amount from the days unit in a copy of this period. 754c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The years and months units are unaffected. 755c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, "1 year, 6 months and 3 days" minus 2 days returns "1 year, 6 months and 1 day". 756c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 757c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 758c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 759c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param daysToSubtract the months to subtract, positive or negative 760c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the specified days subtracted, not null 761c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 762c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 763c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period minusDays(long daysToSubtract) { 764c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return (daysToSubtract == Long.MIN_VALUE ? plusDays(Long.MAX_VALUE).plusDays(1) : plusDays(-daysToSubtract)); 765c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 766c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 767c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 768c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 769c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a new instance with each element in this period multiplied 770c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * by the specified scalar. 771c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 772c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns a period with each of the years, months and days units 773c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * individually multiplied. 774c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, a period of "2 years, -3 months and 4 days" multiplied by 775c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 3 will return "6 years, -9 months and 12 days". 776c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * No normalization is performed. 777c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 778c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param scalar the scalar to multiply by, not null 779c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the amounts multiplied by the scalar, not null 780c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 781c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 782c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period multipliedBy(int scalar) { 783c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (this == ZERO || scalar == 1) { 784c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return this; 785c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 786c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create( 787c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.multiplyExact(years, scalar), 788c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.multiplyExact(months, scalar), 789c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Math.multiplyExact(days, scalar)); 790c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 791c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 792c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 793c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a new instance with each amount in this period negated. 794c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 795c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns a period with each of the years, months and days units 796c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * individually negated. 797c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, a period of "2 years, -3 months and 4 days" will be 798c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * negated to "-2 years, 3 months and -4 days". 799c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * No normalization is performed. 800c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 801c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with the amounts negated, not null 802c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs, which only happens if 803c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * one of the units has the value {@code Long.MIN_VALUE} 804c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 805c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period negated() { 806c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return multipliedBy(-1); 807c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 808c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 809c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 810c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 811c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Returns a copy of this period with the years and months normalized. 812c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 813c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This normalizes the years and months units, leaving the days unit unchanged. 814c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The months unit is adjusted to have an absolute value less than 11, 815c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * with the years unit being adjusted to compensate. For example, a period of 816c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "1 Year and 15 months" will be normalized to "2 years and 3 months". 817c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 818c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The sign of the years and months units will be the same after normalization. 819c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, a period of "1 year and -25 months" will be normalized to 820c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * "-1 year and -1 month". 821c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 822c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 823c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 824c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a {@code Period} based on this period with excess months normalized to years, not null 825c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 826c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 827c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Period normalized() { 828c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer long totalMonths = toTotalMonths(); 829c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer long splitYears = totalMonths / 12; 830c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int splitMonths = (int) (totalMonths % 12); // no overflow 831c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (splitYears == years && splitMonths == months) { 832c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return this; 833c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 834c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return create(Math.toIntExact(splitYears), splitMonths, days); 835c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 836c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 837c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 838c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Gets the total number of months in this period. 839c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 840c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns the total number of months in the period by multiplying the 841c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * number of years by 12 and adding the number of months. 842c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 843c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 844c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 845c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the total number of months in the period, may be negative 846c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 847c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public long toTotalMonths() { 848c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return years * 12L + months; // no overflow 849c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 850c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 851c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //------------------------------------------------------------------------- 852c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 853c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Adds this period to the specified temporal object. 854c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 855c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns a temporal object of the same observable type as the input 856c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * with this period added. 857c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * If the temporal has a chronology, it must be the ISO chronology. 858c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 859c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * In most cases, it is clearer to reverse the calling pattern by using 860c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * {@link Temporal#plus(TemporalAmount)}. 861c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <pre> 862c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * // these two lines are equivalent, but the second approach is recommended 863c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * dateTime = thisPeriod.addTo(dateTime); 864c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * dateTime = dateTime.plus(thisPeriod); 865c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * </pre> 866c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 867c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The calculation operates as follows. 868c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * First, the chronology of the temporal is checked to ensure it is ISO chronology or null. 869c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Second, if the months are zero, the years are added if non-zero, otherwise 870c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * the combination of years and months is added if non-zero. 871c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Finally, any days are added. 872c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 873c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This approach ensures that a partial period can be added to a partial date. 874c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, a period of years and/or months can be added to a {@code YearMonth}, 875c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * but a period including days cannot. 876c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The approach also adds years and months together when necessary, which ensures 877c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * correct behaviour at the end of the month. 878c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 879c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 880c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 881c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param temporal the temporal object to adjust, not null 882c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return an object of the same type with the adjustment made, not null 883c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws DateTimeException if unable to add 884c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 885c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 886c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer @Override 887c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Temporal addTo(Temporal temporal) { 888c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer validateChrono(temporal); 889c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (months == 0) { 890c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (years != 0) { 891c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer temporal = temporal.plus(years, YEARS); 892c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 893c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else { 894c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer long totalMonths = toTotalMonths(); 895c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (totalMonths != 0) { 896c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer temporal = temporal.plus(totalMonths, MONTHS); 897c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 898c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 899c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (days != 0) { 900c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer temporal = temporal.plus(days, DAYS); 901c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 902c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return temporal; 903c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 904c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 905c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 906c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Subtracts this period from the specified temporal object. 907c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 908c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This returns a temporal object of the same observable type as the input 909c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * with this period subtracted. 910c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * If the temporal has a chronology, it must be the ISO chronology. 911c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 912c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * In most cases, it is clearer to reverse the calling pattern by using 913c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * {@link Temporal#minus(TemporalAmount)}. 914c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <pre> 915c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * // these two lines are equivalent, but the second approach is recommended 916c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * dateTime = thisPeriod.subtractFrom(dateTime); 917c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * dateTime = dateTime.minus(thisPeriod); 918c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * </pre> 919c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 920c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The calculation operates as follows. 921c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * First, the chronology of the temporal is checked to ensure it is ISO chronology or null. 922c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Second, if the months are zero, the years are subtracted if non-zero, otherwise 923c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * the combination of years and months is subtracted if non-zero. 924c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Finally, any days are subtracted. 925c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 926c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This approach ensures that a partial period can be subtracted from a partial date. 927c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * For example, a period of years and/or months can be subtracted from a {@code YearMonth}, 928c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * but a period including days cannot. 929c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The approach also subtracts years and months together when necessary, which ensures 930c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * correct behaviour at the end of the month. 931c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 932c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * This instance is immutable and unaffected by this method call. 933c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 934c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param temporal the temporal object to adjust, not null 935c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return an object of the same type with the adjustment made, not null 936c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws DateTimeException if unable to subtract 937c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws ArithmeticException if numeric overflow occurs 938c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 939c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer @Override 940c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public Temporal subtractFrom(Temporal temporal) { 941c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer validateChrono(temporal); 942c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (months == 0) { 943c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (years != 0) { 944c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer temporal = temporal.minus(years, YEARS); 945c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 946c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else { 947c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer long totalMonths = toTotalMonths(); 948c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (totalMonths != 0) { 949c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer temporal = temporal.minus(totalMonths, MONTHS); 950c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 951c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 952c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (days != 0) { 953c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer temporal = temporal.minus(days, DAYS); 954c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 955c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return temporal; 956c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 957c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 958c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 959c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Validates that the temporal has the correct chronology. 960c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 961c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private void validateChrono(TemporalAccessor temporal) { 962c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Objects.requireNonNull(temporal, "temporal"); 963c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Chronology temporalChrono = temporal.query(TemporalQueries.chronology()); 964c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (temporalChrono != null && IsoChronology.INSTANCE.equals(temporalChrono) == false) { 965c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer throw new DateTimeException("Chronology mismatch, expected: ISO, actual: " + temporalChrono.getId()); 966c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 967c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 968c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 969c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 970c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 971c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Checks if this period is equal to another period. 972c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 973c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The comparison is based on the type {@code Period} and each of the three amounts. 974c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * To be equal, the years, months and days units must be individually equal. 975c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Note that this means that a period of "15 Months" is not equal to a period 976c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * of "1 Year and 3 Months". 977c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 978c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param obj the object to check, null returns false 979c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return true if this is equal to the other period 980c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 981c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer @Override 982c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public boolean equals(Object obj) { 983c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (this == obj) { 984c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return true; 985c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 986c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (obj instanceof Period) { 987c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer Period other = (Period) obj; 988c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return years == other.years && 989c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer months == other.months && 990c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer days == other.days; 991c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 992c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return false; 993c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 994c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 995c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 996c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * A hash code for this period. 997c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 998c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a suitable hash code 999c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 1000c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer @Override 1001c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public int hashCode() { 1002c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return years + Integer.rotateLeft(months, 8) + Integer.rotateLeft(days, 16); 1003c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1004c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 1005c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 1006c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 1007c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Outputs this period as a {@code String}, such as {@code P6Y3M1D}. 1008c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <p> 1009c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * The output will be in the ISO-8601 period format. 1010c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * A zero period will be represented as zero days, 'P0D'. 1011c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 1012c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return a string representation of this period, not null 1013c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 1014c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer @Override 1015c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer public String toString() { 1016c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (this == ZERO) { 1017c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return "P0D"; 1018c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } else { 1019c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer StringBuilder buf = new StringBuilder(); 1020c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer buf.append('P'); 1021c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (years != 0) { 1022c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer buf.append(years).append('Y'); 1023c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1024c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (months != 0) { 1025c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer buf.append(months).append('M'); 1026c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1027c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer if (days != 0) { 1028c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer buf.append(days).append('D'); 1029c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1030c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return buf.toString(); 1031c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1032c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1033c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 1034c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer //----------------------------------------------------------------------- 1035c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 1036c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Writes the object using a 1037c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <a href="../../serialized-form.html#java.time.Ser">dedicated serialized form</a>. 1038c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @serialData 1039c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * <pre> 1040c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * out.writeByte(14); // identifies a Period 1041c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * out.writeInt(years); 1042c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * out.writeInt(months); 1043c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * out.writeInt(days); 1044c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * </pre> 1045c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 1046c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @return the instance of {@code Ser}, not null 1047c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 1048c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private Object writeReplace() { 1049c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return new Ser(Ser.PERIOD_TYPE, this); 1050c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1051c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 1052c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer /** 1053c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * Defend against malicious streams. 1054c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * 1055c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @param s the stream to read 1056c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer * @throws java.io.InvalidObjectException always 1057c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer */ 1058c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer private void readObject(ObjectInputStream s) throws InvalidObjectException { 1059c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer throw new InvalidObjectException("Deserialization via serialization delegate"); 1060c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1061c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 1062c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer void writeExternal(DataOutput out) throws IOException { 1063c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer out.writeInt(years); 1064c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer out.writeInt(months); 1065c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer out.writeInt(days); 1066c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1067c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 1068c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer static Period readExternal(DataInput in) throws IOException { 1069c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int years = in.readInt(); 1070c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int months = in.readInt(); 1071c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer int days = in.readInt(); 1072c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer return Period.of(years, months, days); 1073c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer } 1074c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer 1075c9dd3385ea6f927052783f42fb1282fb093e636eJoachim Sauer} 1076