YearQuarter

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 ChronoField.YEAR and IsoFields.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.

Throw:

function overloading for YearQuarter.now

• if called with 0 argument YearQuarter._now0 is executed,
• if called with 1 argument and first argument is an instance of ZoneId, then YearQuarter._nowZoneId is executed,
• otherwise YearQuarter._nowClock is executed

function overloading for YearQuarter.of

• if called with {Year} and {Quarter} YearQuarter._ofYearQuarter is executed,
• if called with {Year} and {number} YearQuarter._ofYearInt is executed,
• if called with {number} and {Quarter} YearQuarter._ofIntQuarter is executed,
• if called with {number} and {number} YearQuarter._ofIntInt is executed, otherwise throws IllegalArgumentException.

Obtains an instance of YearQuarter from a text string using a specific formatter.

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

Throw:

Obtains the current year-quarter from the system clock in the default time-zone.

This will query the Clock.systemDefaultZone 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.

Obtains the current year-quarter from the system clock in the specified time-zone.

This will query the Clock.system 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.

Obtains an instance of YearQuarter from a year and quarter.

Throw:

Obtains an instance of YearQuarter from a year and quarter.

Throw:

Obtains an instance of YearQuarter from a year and quarter.

Throw:

Obtains an instance of YearQuarter from a year and quarter.

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 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:

  // 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.

Throw:

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);

Throw:

See:

• YearQuarter.isValidDay

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();

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.

Checks if this year-quarter is equal to another year-quarter.

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

Formats this year-quarter using the specified formatter.

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

Throw:

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 YearQuarter.isSupported 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.

Throw:

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 YearQuarter.isSupported 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.

Throw:

A hash code for this year-quarter.

Is this year-quarter after the specified year-quarter.

Is this year-quarter before the specified year-quarter.

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.

function overloading for YearWeek.isSupported

• if called with an instance of TemporalField, then YearWeek.isSupportedField is executed,
• if called with an instance of TemporalUnit, then YearWeek.isSupportedUnit is executed,
• otherwise IllegalArgumentException is thrown.

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.

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 year.

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

Returns a copy of this year-quarter with the specified period in quarters subtracted.

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this year-quarter with the specified period in years subtracted.

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this year-quarter with the specified period in quarters added.

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this year-quarter with the specified period in years added.

This instance is immutable and unaffected by this method call.

Throw:

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 Quarter.value.

See:

• YearQuarter.quarterValue

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 YearQuarter.getQuarter.

See:

• YearQuarter.quarter

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 method on the specified query passing this as the argument.

Throw:

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 YearQuarter.isSupported 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.

Throw:

Outputs this year-quarter as a String, such as 2007-Q2.

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

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 YearQuarter.from. 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:

  // these two lines are equivalent
  amount = start.until(end, QUARTER_YEARS);
  amount = QUARTER_YEARS.between(start, end);

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.

Throw:

Returns a copy of this YearQuarter with the quarter-of-year altered.

This instance is immutable and unaffected by this method call.

Throw:

Returns a copy of this YearQuarter with the year altered.

This instance is immutable and unaffected by this method call.

Throw:

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).

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 YearQuarter.range, YearQuarter.get and YearQuarter.with 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.

Checks if the specified unit is supported.

This checks if the specified unit can be added to, or subtracted from, this year-quarter. If false, then calling the YearQuarter.plus and YearQuarter.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.