public final Enum Quarter

The singleton instance for the first quarter-of-year, from January to March. This has the numeric value of 1.

The singleton instance for the second quarter-of-year, from April to June. This has the numeric value of 2.

The singleton instance for the third quarter-of-year, from July to September. This has the numeric value of 3.

The singleton instance for the fourth quarter-of-year, from October to December. This has the numeric value of 4.

Implements java.time.temporal.TemporalAdjuster.adjustInto.

Adjusts the specified temporal object to have this quarter-of-year.

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

The adjustment is equivalent to using Temporal#with(TemporalField, long) passing IsoFields#QUARTER_OF_YEAR as the field. 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 = thisQuarter.adjustInto(temporal);
  temporal = temporal.with(thisQuarter);

For example, given a date in May, the following are output:

  dateInMay.with(Q1);    // three months earlier
  dateInMay.with(Q2);    // no change
  dateInMay.with(Q3);    // three months later
  dateInMay.with(Q4);    // six months later

This instance is immutable and unaffected by this method call.

Parameters

temporal:Temporal

the target object to be adjusted, not null

Returns:Temporal

the adjusted object, not null

Annotations

@Override

Exceptions

DateTimeException:

if unable to make the adjustment

ArithmeticException:

if numeric overflow occurs

Gets the first of the three months that this quarter refers to.

Q1 will return January.
Q2 will return April.
Q3 will return July.
Q4 will return October.

To obtain the other two months of the quarter, simply use Month#plus(long) on the returned month.

Returns:Month

the first month in the quarter, not null

Obtains an instance of Quarter from a temporal object.

This obtains a 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 Quarter.

The conversion extracts the QUARTER_OF_YEAR field. 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, Quarter::from.

Parameters

temporal:TemporalAccessor

the temporal-time object to convert, not null

Returns:Quarter

the quarter-of-year, not null

Exceptions

DateTimeException:

if unable to convert to a Quarter

Overrides default java.time.temporal.TemporalAccessor.get.

Gets the value of the specified field from this quarter-of-year as an int.

This queries this 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 QUARTER_OF_YEAR then the value of the quarter-of-year, from 1 to 4, will be returned. All 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.

Parameters

field:TemporalField

the field to get, not null

Returns:int

the value for the field, within the valid range of values

Annotations

@Override

Exceptions

DateTimeException:

if a value for the field cannot be obtained or the value is outside the range of valid values for the field

UnsupportedTemporalTypeException:

if the field is not supported or the range of values exceeds an int

ArithmeticException:

if numeric overflow occurs

Gets the textual representation, such as 'Q1' or '4th quarter'.

This returns the textual name used to identify the quarter-of-year, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

If no textual mapping is found then the numeric value is returned.

Parameters

style:TextStyle

the length of the text required, not null

locale:Locale

the locale to use, not null

Returns:String

the text value of the quarter-of-year, not null

Implements java.time.temporal.TemporalAccessor.getLong.

Gets the value of the specified field from this quarter-of-year as a long.

This queries this 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 QUARTER_OF_YEAR then the value of the quarter-of-year, from 1 to 4, will be returned. 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.

Parameters

field:TemporalField

the field to get, not null

Returns:long

the value for the field

Annotations

@Override

Exceptions

DateTimeException:

if a value for the field cannot be obtained

UnsupportedTemporalTypeException:

if the field is not supported

ArithmeticException:

if numeric overflow occurs

Gets the quarter-of-year int value.

The values are numbered following the ISO-8601 standard, from 1 (Q1) to 4 (Q4).

Returns:int

the quarter-of-year, from 1 (Q1) to 4 (Q4)

Implements java.time.temporal.TemporalAccessor.isSupported.

Checks if the specified field is supported.

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

If the field is QUARTER_OF_YEAR then this method returns true. All 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.

Parameters

field:TemporalField

the field to check, null returns false

Returns:boolean

true if the field is supported on this quarter-of-year, false if not

Annotations

@Override

Gets the length of this quarter in days.

This takes a flag to determine whether to return the length for a leap year or not.

Q1 has 90 in a standard year and 91 days in a leap year. Q2 has 91 days. Q3 and Q4 have 92 days.

Parameters

leapYear:boolean

true if the length is required for a leap year

Returns:int

the length of this month in days, from 90 to 92

Returns the quarter that is the specified number of quarters before this one.

The calculation rolls around the start of the year from Q1 to Q4. The specified period may be negative.

This instance is immutable and unaffected by this method call.

Parameters

quarters:long

the quarters to subtract, positive or negative

Returns:Quarter

the resulting quarter, not null

Obtains an instance of Quarter from an int value.

Quarter is an enum representing the 4 quarters of the year. This factory allows the enum to be obtained from the int value. The int value follows the quarter, from 1 (Q1) to 4 (Q4).

Parameters

quarterOfYear:int

the quarter-of-year to represent, from 1 (Q1) to 4 (Q4)

Returns:Quarter

the quarter-of-year, not null

Exceptions

DateTimeException:

if the quarter-of-year is invalid

Obtains an instance of Quarter from a month-of-year.

Quarter is an enum representing the 4 quarters of the year. This factory allows the enum to be obtained from the Month value.

January to March are Q1, April to June are Q2, July to September are Q3 and October to December are Q4.

Parameters

monthOfYear:int

the month-of-year to convert from, from 1 to 12

Returns:Quarter

the quarter-of-year, not null

Exceptions

DateTimeException:

if the month-of-year is invalid

Returns the quarter that is the specified number of quarters after this one.

The calculation rolls around the end of the year from Q4 to Q1. The specified period may be negative.

This instance is immutable and unaffected by this method call.

Parameters

quarters:long

the quarters to add, positive or negative

Returns:Quarter

the resulting quarter, not null

Overrides default java.time.temporal.TemporalAccessor.query.

Queries this quarter-of-year using the specified query.

This queries this quarter-of-year 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.

Parameters

<R>

the type of the result

query:TemporalQuery<R>

the query to invoke, not null

Returns:R

the query result, null may be returned (defined by the query)

Annotations

@SuppressWarnings:unchecked

@Override

Exceptions

DateTimeException:

if unable to query (defined by the query)

ArithmeticException:

if numeric overflow occurs (defined by the query)

Overrides default java.time.temporal.TemporalAccessor.range.

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. This 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 QUARTER_OF_YEAR then the range of the quarter-of-year, from 1 to 4, will be returned. All 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.

Parameters

field:TemporalField

the field to query the range for, not null

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

Exceptions

DateTimeException:

if the range for the field cannot be obtained

UnsupportedTemporalTypeException:

if the field is not supported