Class YearQuarter

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<YearQuarter>, java.time.temporal.Temporal, java.time.temporal.TemporalAccessor, java.time.temporal.TemporalAdjuster

    public final class YearQuarter
    extends java.lang.Object
    implements java.time.temporal.Temporal, java.time.temporal.TemporalAdjuster, java.lang.Comparable<YearQuarter>, java.io.Serializable
    A year-quarter in the ISO-8601 calendar system, such as 2007-Q2.

    YearQuarter is an immutable date-time object that represents the combination of a year and quarter. Any field that can be derived from a year and quarter can be obtained. A quarter is defined by Quarter and Month.firstMonthOfQuarter() - Q1, Q2, Q3 and Q4. Q1 is January to March, Q2 is April to June, Q3 is July to September and Q4 is October to December.

    This class does not store or represent a day, time or time-zone. For example, the value "2nd quarter 2007" can be stored in a YearQuarter.

    The ISO-8601 calendar system is the modern civil calendar system used today in most of the world. It is equivalent to the proleptic Gregorian calendar system, in which today's rules for leap years are applied for all time. For most applications written today, the ISO-8601 rules are entirely suitable. However, any application that makes use of historical dates, and requires them to be accurate will find the ISO-8601 approach unsuitable. Note that the ISO-8601 standard does not define or refer to quarters.

    Implementation Requirements:

    This class is immutable and thread-safe.

    This class must be treated as a value type. Do not synchronize, rely on the identity hash code or use the distinction between equals() and ==.

    See Also:
    Serialized Form
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.time.temporal.Temporal adjustInto​(java.time.temporal.Temporal temporal)
      Adjusts the specified temporal object to have this year-quarter.
      java.time.LocalDate atDay​(int dayOfQuarter)
      Combines this year-quarter with a day-of-quarter to create a LocalDate.
      java.time.LocalDate atEndOfQuarter()
      Returns a LocalDate at the end of the quarter.
      int compareTo​(YearQuarter other)
      Compares this year-quarter to another
      boolean equals​(java.lang.Object obj)
      Checks if this year-quarter is equal to another year-quarter.
      java.lang.String format​(java.time.format.DateTimeFormatter formatter)
      Formats this year-quarter using the specified formatter.
      static YearQuarter from​(java.time.temporal.TemporalAccessor temporal)
      Obtains an instance of YearQuarter from a temporal object.
      int get​(java.time.temporal.TemporalField field)
      Gets the value of the specified field from this year-quarter as an int.
      long getLong​(java.time.temporal.TemporalField field)
      Gets the value of the specified field from this year-quarter as a long.
      Quarter getQuarter()
      Gets the quarter-of-year field using the Quarter enum.
      int getQuarterValue()
      Gets the quarter-of-year field from 1 to 4.
      int getYear()
      Gets the year field.
      int hashCode()
      A hash code for this year-quarter.
      boolean isAfter​(YearQuarter other)
      Is this year-quarter after the specified year-quarter.
      boolean isBefore​(YearQuarter other)
      Is this year-quarter before the specified year-quarter.
      boolean isLeapYear()
      Checks if the year is a leap year, according to the ISO proleptic calendar system rules.
      boolean isSupported​(java.time.temporal.TemporalField field)
      Checks if the specified field is supported.
      boolean isSupported​(java.time.temporal.TemporalUnit unit)
      Checks if the specified unit is supported.
      boolean isValidDay​(int dayOfQuarter)
      Checks if the day-of-quarter is valid for this year-quarter.
      int lengthOfQuarter()
      Returns the length of the quarter, taking account of the year.
      int lengthOfYear()
      Returns the length of the year.
      YearQuarter minus​(long amountToSubtract, java.time.temporal.TemporalUnit unit)
      Returns a copy of this year-quarter with the specified amount subtracted.
      YearQuarter minus​(java.time.temporal.TemporalAmount amountToSubtract)
      Returns a copy of this year-quarter with the specified amount subtracted.
      YearQuarter minusQuarters​(long quartersToSubtract)
      Returns a copy of this year-quarter with the specified period in quarters subtracted.
      YearQuarter minusYears​(long yearsToSubtract)
      Returns a copy of this year-quarter with the specified period in years subtracted.
      static YearQuarter now()
      Obtains the current year-quarter from the system clock in the default time-zone.
      static YearQuarter now​(java.time.Clock clock)
      Obtains the current year-quarter from the specified clock.
      static YearQuarter now​(java.time.ZoneId zone)
      Obtains the current year-quarter from the system clock in the specified time-zone.
      static YearQuarter of​(int year, int quarter)
      Obtains an instance of YearQuarter from a year and quarter.
      static YearQuarter of​(int year, Quarter quarter)
      Obtains an instance of YearQuarter from a year and quarter.
      static YearQuarter parse​(java.lang.CharSequence text)
      Obtains an instance of YearQuarter from a text string such as 2007-Q2.
      static YearQuarter parse​(java.lang.CharSequence text, java.time.format.DateTimeFormatter formatter)
      Obtains an instance of YearQuarter from a text string using a specific formatter.
      YearQuarter plus​(long amountToAdd, java.time.temporal.TemporalUnit unit)
      Returns a copy of this year-quarter with the specified amount added.
      YearQuarter plus​(java.time.temporal.TemporalAmount amountToAdd)
      Returns a copy of this year-quarter with the specified amount added.
      YearQuarter plusQuarters​(long quartersToAdd)
      Returns a copy of this year-quarter with the specified period in quarters added.
      YearQuarter plusYears​(long yearsToAdd)
      Returns a copy of this year-quarter with the specified period in years added.
      <R> R query​(java.time.temporal.TemporalQuery<R> query)
      Queries this year-quarter using the specified query.
      java.time.temporal.ValueRange range​(java.time.temporal.TemporalField field)
      Gets the range of valid values for the specified field.
      java.lang.String toString()
      Outputs this year-quarter as a String, such as 2007-Q2.
      long until​(java.time.temporal.Temporal endExclusive, java.time.temporal.TemporalUnit unit)
      Calculates the amount of time until another year-quarter in terms of the specified unit.
      YearQuarter with​(java.time.temporal.TemporalAdjuster adjuster)
      Returns an adjusted copy of this year-quarter.
      YearQuarter with​(java.time.temporal.TemporalField field, long newValue)
      Returns a copy of this year-quarter with the specified field set to a new value.
      YearQuarter withQuarter​(int quarter)
      Returns a copy of this YearQuarter with the quarter-of-year altered.
      YearQuarter withYear​(int year)
      Returns a copy of this YearQuarter with the year altered.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • now

        public static YearQuarter now()
        Obtains the current year-quarter from the system clock in the default time-zone.

        This will query the system clock in the default time-zone to obtain the current year-quarter. The zone and offset will be set based on the time-zone in the clock.

        Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

        Returns:
        the current year-quarter using the system clock and default time-zone, not null
      • now

        public static YearQuarter now​(java.time.ZoneId zone)
        Obtains the current year-quarter from the system clock in the specified time-zone.

        This will query the system clock to obtain the current year-quarter. Specifying the time-zone avoids dependence on the default time-zone.

        Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

        Parameters:
        zone - the zone ID to use, not null
        Returns:
        the current year-quarter using the system clock, not null
      • now

        public static YearQuarter now​(java.time.Clock clock)
        Obtains the current year-quarter from the specified clock.

        This will query the specified clock to obtain the current year-quarter. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

        Parameters:
        clock - the clock to use, not null
        Returns:
        the current year-quarter, not null
      • of

        public static YearQuarter of​(int year,
                                     Quarter quarter)
        Obtains an instance of YearQuarter from a year and quarter.
        Parameters:
        year - the year to represent, from MIN_YEAR to MAX_YEAR
        quarter - the quarter-of-year to represent, not null
        Returns:
        the year-quarter, not null
        Throws:
        java.time.DateTimeException - if the year value is invalid
      • of

        public static YearQuarter of​(int year,
                                     int quarter)
        Obtains an instance of YearQuarter from a year and quarter.
        Parameters:
        year - the year to represent, from MIN_YEAR to MAX_YEAR
        quarter - the quarter-of-year to represent, from 1 to 4
        Returns:
        the year-quarter, not null
        Throws:
        java.time.DateTimeException - if either field value is invalid
      • from

        public static YearQuarter from​(java.time.temporal.TemporalAccessor temporal)
        Obtains an instance of YearQuarter from a temporal object.

        This obtains a year-quarter based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of YearQuarter.

        The conversion extracts the YEAR and QUARTER_OF_YEAR fields. The extraction is only permitted if the temporal object has an ISO chronology, or can be converted to a LocalDate.

        This method matches the signature of the functional interface TemporalQuery allowing it to be used in queries via method reference, YearQuarter::from.

        Parameters:
        temporal - the temporal object to convert, not null
        Returns:
        the year-quarter, not null
        Throws:
        java.time.DateTimeException - if unable to convert to a YearQuarter
      • parse

        public static YearQuarter parse​(java.lang.CharSequence text)
        Obtains an instance of YearQuarter from a text string such as 2007-Q2.

        The string must represent a valid year-quarter. The format must be uuuu-'Q'Q where the 'Q' is case insensitive. Years outside the range 0000 to 9999 must be prefixed by the plus or minus symbol.

        Parameters:
        text - the text to parse such as "2007-Q2", not null
        Returns:
        the parsed year-quarter, not null
        Throws:
        java.time.format.DateTimeParseException - if the text cannot be parsed
      • parse

        public static YearQuarter parse​(java.lang.CharSequence text,
                                        java.time.format.DateTimeFormatter formatter)
        Obtains an instance of YearQuarter from a text string using a specific formatter.

        The text is parsed using the formatter, returning a year-quarter.

        Parameters:
        text - the text to parse, not null
        formatter - the formatter to use, not null
        Returns:
        the parsed year-quarter, not null
        Throws:
        java.time.format.DateTimeParseException - if the text cannot be parsed
      • isSupported

        public boolean isSupported​(java.time.temporal.TemporalField field)
        Checks if the specified field is supported.

        This checks if this year-quarter can be queried for the specified field. If false, then calling the range, get and with(TemporalField, long) methods will throw an exception.

        If the field is a ChronoField then the query is implemented here. The supported fields are:

        • QUARTER_OF_YEAR
        • YEAR_OF_ERA
        • YEAR
        • ERA
        All other ChronoField instances will return false.

        If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

        Specified by:
        isSupported in interface java.time.temporal.TemporalAccessor
        Parameters:
        field - the field to check, null returns false
        Returns:
        true if the field is supported on this year-quarter, false if not
      • isSupported

        public boolean isSupported​(java.time.temporal.TemporalUnit unit)
        Checks if the specified unit is supported.

        This checks if the specified unit can be added to, or subtracted from, this date-time. If false, then calling the plus(long, TemporalUnit) and minus methods will throw an exception.

        If the unit is a ChronoUnit then the query is implemented here. The supported units are:

        • QUARTER_YEARS
        • YEARS
        • DECADES
        • CENTURIES
        • MILLENNIA
        • ERAS
        All other ChronoUnit instances will return false.

        If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument. Whether the unit is supported is determined by the unit.

        Specified by:
        isSupported in interface java.time.temporal.Temporal
        Parameters:
        unit - the unit to check, null returns false
        Returns:
        true if the unit can be added/subtracted, false if not
      • range

        public java.time.temporal.ValueRange range​(java.time.temporal.TemporalField field)
        Gets the range of valid values for the specified field.

        The range object expresses the minimum and maximum valid values for a field. This year-quarter is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

        If the field is a ChronoField then the query is implemented here. The supported fields will return appropriate range instances. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

        If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

        Specified by:
        range in interface java.time.temporal.TemporalAccessor
        Parameters:
        field - the field to query the range for, not null
        Returns:
        the range of valid values for the field, not null
        Throws:
        java.time.DateTimeException - if the range for the field cannot be obtained
        java.time.temporal.UnsupportedTemporalTypeException - if the field is not supported
      • get

        public int get​(java.time.temporal.TemporalField field)
        Gets the value of the specified field from this year-quarter as an int.

        This queries this year-quarter for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

        If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this year-quarter,. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

        If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

        Specified by:
        get in interface java.time.temporal.TemporalAccessor
        Parameters:
        field - the field to get, not null
        Returns:
        the value for the field
        Throws:
        java.time.DateTimeException - if a value for the field cannot be obtained or the value is outside the range of valid values for the field
        java.time.temporal.UnsupportedTemporalTypeException - if the field is not supported or the range of values exceeds an int
        java.lang.ArithmeticException - if numeric overflow occurs
      • getLong

        public long getLong​(java.time.temporal.TemporalField field)
        Gets the value of the specified field from this year-quarter as a long.

        This queries this year-quarter for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

        If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this year-quarter. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

        If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

        Specified by:
        getLong in interface java.time.temporal.TemporalAccessor
        Parameters:
        field - the field to get, not null
        Returns:
        the value for the field
        Throws:
        java.time.DateTimeException - if a value for the field cannot be obtained
        java.time.temporal.UnsupportedTemporalTypeException - if the field is not supported
        java.lang.ArithmeticException - if numeric overflow occurs
      • getYear

        public int getYear()
        Gets the year field.

        This method returns the primitive int value for the year.

        The year returned by this method is proleptic as per get(YEAR).

        Returns:
        the year, from MIN_YEAR to MAX_YEAR
      • getQuarterValue

        public int getQuarterValue()
        Gets the quarter-of-year field from 1 to 4.

        This method returns the quarter as an int from 1 to 4. Application code is frequently clearer if the enum Quarter is used by calling getQuarter().

        Returns:
        the quarter-of-year, from 1 to 4
        See Also:
        getQuarter()
      • getQuarter

        public Quarter getQuarter()
        Gets the quarter-of-year field using the Quarter enum.

        This method returns the enum Quarter for the quarter. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.

        Returns:
        the quarter-of-year, not null
        See Also:
        getQuarterValue()
      • isLeapYear

        public boolean isLeapYear()
        Checks if the year is a leap year, according to the ISO proleptic calendar system rules.

        This method applies the current rules for leap years across the whole time-line. In general, a year is a leap year if it is divisible by four without remainder. However, years divisible by 100, are not leap years, with the exception of years divisible by 400 which are.

        For example, 1904 is a leap year it is divisible by 4. 1900 was not a leap year as it is divisible by 100, however 2000 was a leap year as it is divisible by 400.

        The calculation is proleptic - applying the same rules into the far future and far past. This is historically inaccurate, but is correct for the ISO-8601 standard.

        Returns:
        true if the year is leap, false otherwise
      • isValidDay

        public boolean isValidDay​(int dayOfQuarter)
        Checks if the day-of-quarter is valid for this year-quarter.

        This method checks whether this year and quarter and the input day form a valid date.

        Parameters:
        dayOfQuarter - the day-of-quarter to validate, from 1 to 92, invalid value returns false
        Returns:
        true if the day is valid for this year-quarter
      • lengthOfQuarter

        public int lengthOfQuarter()
        Returns the length of the quarter, taking account of the year.

        This returns the length of the quarter in days.

        Returns:
        the length of the quarter in days, from 90 to 92
      • lengthOfYear

        public int lengthOfYear()
        Returns the length of the year.

        This returns the length of the year in days, either 365 or 366.

        Returns:
        366 if the year is leap, 365 otherwise
      • with

        public YearQuarter with​(java.time.temporal.TemporalAdjuster adjuster)
        Returns an adjusted copy of this year-quarter.

        This returns a YearQuarter, based on this one, with the year-quarter adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.

        A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the year-quarter to the next quarter that Halley's comet will pass the Earth.

        The result of this method is obtained by invoking the TemporalAdjuster.adjustInto(Temporal) method on the specified adjuster passing this as the argument.

        This instance is immutable and unaffected by this method call.

        Specified by:
        with in interface java.time.temporal.Temporal
        Parameters:
        adjuster - the adjuster to use, not null
        Returns:
        a YearQuarter based on this with the adjustment made, not null
        Throws:
        java.time.DateTimeException - if the adjustment cannot be made
        java.lang.ArithmeticException - if numeric overflow occurs
      • with

        public YearQuarter with​(java.time.temporal.TemporalField field,
                                long newValue)
        Returns a copy of this year-quarter with the specified field set to a new value.

        This returns a YearQuarter, based on this one, with the value for the specified field changed. This can be used to change any supported field, such as the year or quarter. If it is not possible to set the value, because the field is not supported or for some other reason, an exception is thrown.

        If the field is a ChronoField then the adjustment is implemented here. The supported fields behave as follows:

        • QUARTER_OF_YEAR - Returns a YearQuarter with the specified quarter-of-year. The year will be unchanged.
        • YEAR_OF_ERA - Returns a YearQuarter with the specified year-of-era The quarter and era will be unchanged.
        • YEAR - Returns a YearQuarter with the specified year. The quarter will be unchanged.
        • ERA - Returns a YearQuarter with the specified era. The quarter and year-of-era will be unchanged.

        In all cases, if the new value is outside the valid range of values for the field then a DateTimeException will be thrown.

        All other ChronoField instances will throw an UnsupportedTemporalTypeException.

        If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.adjustInto(Temporal, long) passing this as the argument. In this case, the field determines whether and how to adjust the instant.

        This instance is immutable and unaffected by this method call.

        Specified by:
        with in interface java.time.temporal.Temporal
        Parameters:
        field - the field to set in the result, not null
        newValue - the new value of the field in the result
        Returns:
        a YearQuarter based on this with the specified field set, not null
        Throws:
        java.time.DateTimeException - if the field cannot be set
        java.time.temporal.UnsupportedTemporalTypeException - if the field is not supported
        java.lang.ArithmeticException - if numeric overflow occurs
      • withYear

        public YearQuarter withYear​(int year)
        Returns a copy of this YearQuarter with the year altered.

        This instance is immutable and unaffected by this method call.

        Parameters:
        year - the year to set in the returned year-quarter, from MIN_YEAR to MAX_YEAR
        Returns:
        a YearQuarter based on this year-quarter with the requested year, not null
        Throws:
        java.time.DateTimeException - if the year value is invalid
      • withQuarter

        public YearQuarter withQuarter​(int quarter)
        Returns a copy of this YearQuarter with the quarter-of-year altered.

        This instance is immutable and unaffected by this method call.

        Parameters:
        quarter - the quarter-of-year to set in the returned year-quarter, from 1 to 4
        Returns:
        a YearQuarter based on this year-quarter with the requested quarter, not null
        Throws:
        java.time.DateTimeException - if the quarter-of-year value is invalid
      • plus

        public YearQuarter plus​(java.time.temporal.TemporalAmount amountToAdd)
        Returns a copy of this year-quarter with the specified amount added.

        This returns a YearQuarter, based on this one, with the specified amount added. The amount is typically Period but may be any other type implementing the TemporalAmount interface.

        The calculation is delegated to the amount object by calling TemporalAmount.addTo(Temporal). The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to plus(long, TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully added.

        This instance is immutable and unaffected by this method call.

        Specified by:
        plus in interface java.time.temporal.Temporal
        Parameters:
        amountToAdd - the amount to add, not null
        Returns:
        a YearQuarter based on this year-quarter with the addition made, not null
        Throws:
        java.time.DateTimeException - if the addition cannot be made
        java.lang.ArithmeticException - if numeric overflow occurs
      • plus

        public YearQuarter plus​(long amountToAdd,
                                java.time.temporal.TemporalUnit unit)
        Returns a copy of this year-quarter with the specified amount added.

        This returns a YearQuarter, based on this one, with the amount in terms of the unit added. If it is not possible to add the amount, because the unit is not supported or for some other reason, an exception is thrown.

        If the field is a ChronoUnit then the addition is implemented here. The supported fields behave as follows:

        • QUARTER_YEARS - Returns a YearQuarter with the specified number of quarters added. This is equivalent to plusQuarters(long).
        • YEARS - Returns a YearQuarter with the specified number of years added. This is equivalent to plusYears(long).
        • DECADES - Returns a YearQuarter with the specified number of decades added. This is equivalent to calling plusYears(long) with the amount multiplied by 10.
        • CENTURIES - Returns a YearQuarter with the specified number of centuries added. This is equivalent to calling plusYears(long) with the amount multiplied by 100.
        • MILLENNIA - Returns a YearQuarter with the specified number of millennia added. This is equivalent to calling plusYears(long) with the amount multiplied by 1,000.
        • ERAS - Returns a YearQuarter with the specified number of eras added. Only two eras are supported so the amount must be one, zero or minus one. If the amount is non-zero then the year is changed such that the year-of-era is unchanged.

        All other ChronoUnit instances will throw an UnsupportedTemporalTypeException.

        If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long) passing this as the argument. In this case, the unit determines whether and how to perform the addition.

        This instance is immutable and unaffected by this method call.

        Specified by:
        plus in interface java.time.temporal.Temporal
        Parameters:
        amountToAdd - the amount of the unit to add to the result, may be negative
        unit - the unit of the amount to add, not null
        Returns:
        a YearQuarter based on this year-quarter with the specified amount added, not null
        Throws:
        java.time.DateTimeException - if the addition cannot be made
        java.time.temporal.UnsupportedTemporalTypeException - if the unit is not supported
        java.lang.ArithmeticException - if numeric overflow occurs
      • plusYears

        public YearQuarter plusYears​(long yearsToAdd)
        Returns a copy of this year-quarter with the specified period in years added.

        This instance is immutable and unaffected by this method call.

        Parameters:
        yearsToAdd - the years to add, may be negative
        Returns:
        a YearQuarter based on this year-quarter with the years added, not null
        Throws:
        java.time.DateTimeException - if the result exceeds the supported range
      • plusQuarters

        public YearQuarter plusQuarters​(long quartersToAdd)
        Returns a copy of this year-quarter with the specified period in quarters added.

        This instance is immutable and unaffected by this method call.

        Parameters:
        quartersToAdd - the quarters to add, may be negative
        Returns:
        a YearQuarter based on this year-quarter with the quarters added, not null
        Throws:
        java.time.DateTimeException - if the result exceeds the supported range
      • minus

        public YearQuarter minus​(java.time.temporal.TemporalAmount amountToSubtract)
        Returns a copy of this year-quarter with the specified amount subtracted.

        This returns a YearQuarter, based on this one, with the specified amount subtracted. The amount is typically Period but may be any other type implementing the TemporalAmount interface.

        The calculation is delegated to the amount object by calling TemporalAmount.subtractFrom(Temporal). The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to minus(long, TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully subtracted.

        This instance is immutable and unaffected by this method call.

        Specified by:
        minus in interface java.time.temporal.Temporal
        Parameters:
        amountToSubtract - the amount to subtract, not null
        Returns:
        a YearQuarter based on this year-quarter with the subtraction made, not null
        Throws:
        java.time.DateTimeException - if the subtraction cannot be made
        java.lang.ArithmeticException - if numeric overflow occurs
      • minus

        public YearQuarter minus​(long amountToSubtract,
                                 java.time.temporal.TemporalUnit unit)
        Returns a copy of this year-quarter with the specified amount subtracted.

        This returns a YearQuarter, based on this one, with the amount in terms of the unit subtracted. If it is not possible to subtract the amount, because the unit is not supported or for some other reason, an exception is thrown.

        This method is equivalent to plus(long, TemporalUnit) with the amount negated. See that method for a full description of how addition, and thus subtraction, works.

        This instance is immutable and unaffected by this method call.

        Specified by:
        minus in interface java.time.temporal.Temporal
        Parameters:
        amountToSubtract - the amount of the unit to subtract from the result, may be negative
        unit - the unit of the amount to subtract, not null
        Returns:
        a YearQuarter based on this year-quarter with the specified amount subtracted, not null
        Throws:
        java.time.DateTimeException - if the subtraction cannot be made
        java.time.temporal.UnsupportedTemporalTypeException - if the unit is not supported
        java.lang.ArithmeticException - if numeric overflow occurs
      • minusYears

        public YearQuarter minusYears​(long yearsToSubtract)
        Returns a copy of this year-quarter with the specified period in years subtracted.

        This instance is immutable and unaffected by this method call.

        Parameters:
        yearsToSubtract - the years to subtract, may be negative
        Returns:
        a YearQuarter based on this year-quarter with the years subtracted, not null
        Throws:
        java.time.DateTimeException - if the result exceeds the supported range
      • minusQuarters

        public YearQuarter minusQuarters​(long quartersToSubtract)
        Returns a copy of this year-quarter with the specified period in quarters subtracted.

        This instance is immutable and unaffected by this method call.

        Parameters:
        quartersToSubtract - the quarters to subtract, may be negative
        Returns:
        a YearQuarter based on this year-quarter with the quarters subtracted, not null
        Throws:
        java.time.DateTimeException - if the result exceeds the supported range
      • query

        public <R> R query​(java.time.temporal.TemporalQuery<R> query)
        Queries this year-quarter using the specified query.

        This queries this year-quarter using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

        The result of this method is obtained by invoking the TemporalQuery.queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

        Specified by:
        query in interface java.time.temporal.TemporalAccessor
        Type Parameters:
        R - the type of the result
        Parameters:
        query - the query to invoke, not null
        Returns:
        the query result, null may be returned (defined by the query)
        Throws:
        java.time.DateTimeException - if unable to query (defined by the query)
        java.lang.ArithmeticException - if numeric overflow occurs (defined by the query)
      • adjustInto

        public java.time.temporal.Temporal adjustInto​(java.time.temporal.Temporal temporal)
        Adjusts the specified temporal object to have this year-quarter.

        This returns a temporal object of the same observable type as the input with the year and quarter changed to be the same as this.

        The adjustment is equivalent to using Temporal.plus(long, TemporalUnit) passing the number of quarters to adjust by. If the specified temporal object does not use the ISO calendar system then a DateTimeException is thrown.

        In most cases, it is clearer to reverse the calling pattern by using Temporal.with(TemporalAdjuster):

           // these two lines are equivalent, but the second approach is recommended
           temporal = thisYearQuarter.adjustInto(temporal);
           temporal = temporal.with(thisYearQuarter);
         

        This instance is immutable and unaffected by this method call.

        Specified by:
        adjustInto in interface java.time.temporal.TemporalAdjuster
        Parameters:
        temporal - the target object to be adjusted, not null
        Returns:
        the adjusted object, not null
        Throws:
        java.time.DateTimeException - if unable to make the adjustment
        java.lang.ArithmeticException - if numeric overflow occurs
      • until

        public long until​(java.time.temporal.Temporal endExclusive,
                          java.time.temporal.TemporalUnit unit)
        Calculates the amount of time until another year-quarter in terms of the specified unit.

        This calculates the amount of time between two YearQuarter objects in terms of a single TemporalUnit. The start and end points are this and the specified year-quarter. The result will be negative if the end is before the start. The Temporal passed to this method is converted to a YearQuarter using from(TemporalAccessor). For example, the period in years between two year-quarters can be calculated using startYearQuarter.until(endYearQuarter, YEARS).

        The calculation returns a whole number, representing the number of complete units between the two year-quarters. For example, the period in decades between 2012-Q3 and 2032-Q2 will only be one decade as it is one quarter short of two decades.

        There are two equivalent ways of using this method. The first is to invoke this method. The second is to use TemporalUnit.between(Temporal, Temporal):

           // these two lines are equivalent
           amount = start.until(end, QUARTER_YEARS);
           amount = QUARTER_YEARS.between(start, end);
         
        The choice should be made based on which makes the code more readable.

        The calculation is implemented in this method for ChronoUnit. The units QUARTER_YEARS, YEARS, DECADES, CENTURIES, MILLENNIA and ERAS are supported. Other ChronoUnit values will throw an exception.

        If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the converted input temporal as the second argument.

        This instance is immutable and unaffected by this method call.

        Specified by:
        until in interface java.time.temporal.Temporal
        Parameters:
        endExclusive - the end date, exclusive, which is converted to a YearQuarter, not null
        unit - the unit to measure the amount in, not null
        Returns:
        the amount of time between this year-quarter and the end year-quarter
        Throws:
        java.time.DateTimeException - if the amount cannot be calculated, or the end temporal cannot be converted to a YearQuarter
        java.time.temporal.UnsupportedTemporalTypeException - if the unit is not supported
        java.lang.ArithmeticException - if numeric overflow occurs
      • format

        public java.lang.String format​(java.time.format.DateTimeFormatter formatter)
        Formats this year-quarter using the specified formatter.

        This year-quarter will be passed to the formatter to produce a string.

        Parameters:
        formatter - the formatter to use, not null
        Returns:
        the formatted year-quarter string, not null
        Throws:
        java.time.DateTimeException - if an error occurs during printing
      • atDay

        public java.time.LocalDate atDay​(int dayOfQuarter)
        Combines this year-quarter with a day-of-quarter to create a LocalDate.

        This returns a LocalDate formed from this year-quarter and the specified day-of-quarter.

        The day-of-quarter value must be valid for the year-quarter.

        This method can be used as part of a chain to produce a date:

          LocalDate date = yearQuarter.atDay(day);
         
        Parameters:
        dayOfQuarter - the day-of-quarter to use, from 1 to 92
        Returns:
        the date formed from this year-quarter and the specified day, not null
        Throws:
        java.time.DateTimeException - if the day is invalid for the year-quarter
        See Also:
        isValidDay(int)
      • atEndOfQuarter

        public java.time.LocalDate atEndOfQuarter()
        Returns a LocalDate at the end of the quarter.

        This returns a LocalDate based on this year-quarter. The day-of-quarter is set to the last valid day of the quarter, taking into account leap years.

        This method can be used as part of a chain to produce a date:

          LocalDate date = year.atQuarter(quarter).atEndOfQuarter();
         
        Returns:
        the last valid date of this year-quarter, not null
      • compareTo

        public int compareTo​(YearQuarter other)
        Compares this year-quarter to another

        The comparison is based first on the value of the year, then on the value of the quarter. It is "consistent with equals", as defined by Comparable.

        Specified by:
        compareTo in interface java.lang.Comparable<YearQuarter>
        Parameters:
        other - the other year-quarter to compare to, not null
        Returns:
        the comparator value, negative if less, positive if greater
      • isAfter

        public boolean isAfter​(YearQuarter other)
        Is this year-quarter after the specified year-quarter.
        Parameters:
        other - the other year-quarter to compare to, not null
        Returns:
        true if this is after the specified year-quarter
      • isBefore

        public boolean isBefore​(YearQuarter other)
        Is this year-quarter before the specified year-quarter.
        Parameters:
        other - the other year-quarter to compare to, not null
        Returns:
        true if this point is before the specified year-quarter
      • equals

        public boolean equals​(java.lang.Object obj)
        Checks if this year-quarter is equal to another year-quarter.

        The comparison is based on the time-line position of the year-quarters.

        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object to check, null returns false
        Returns:
        true if this is equal to the other year-quarter
      • hashCode

        public int hashCode()
        A hash code for this year-quarter.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a suitable hash code
      • toString

        public java.lang.String toString()
        Outputs this year-quarter as a String, such as 2007-Q2.

        The output will be in the format uuuu-'Q'Q:

        Overrides:
        toString in class java.lang.Object
        Returns:
        a string representation of this year-quarter, not null