CalendarQuarter (Time4J-Range 4.38 API)

java.lang.Object
- net.time4j.engine.ChronoEntity<T>
- - net.time4j.range.FixedCalendarInterval<CalendarQuarter>
  - - net.time4j.range.CalendarQuarter

All Implemented Interfaces:

Serializable, Comparable<CalendarQuarter>, Iterable<PlainDate>, ChronoDisplay, LocalizedPatternSupport, ChronoInterval<PlainDate>
```
@CalendarType(value="iso8601")
public final class CalendarQuarter
extends FixedCalendarInterval<CalendarQuarter>
implements LocalizedPatternSupport
```
Represents the quarter of a gregorian calendar year as interval (like from 1st of January until end of March).

The elements registered by this class are:
- YEAR
- QUARTER_OF_YEAR
Note: The current quarter of calendar year can be determined by an expression like: nowInSystemTime() or in a more general way CalendarQuarter current = SystemClock.inLocalView().now(CalendarQuarter.chronology()).
Since:

3.21/4.17

Author:

Meno Hochschild

See Also:

Serialized Form

Concurrency:
This class is immutable and can be used by multiple threads in parallel.

Field Summary

Fields
Modifier and Type	Field and Description
`static ChronoElement<Quarter>`	`QUARTER_OF_YEAR` Element with the quarter of year in the value range `Q1-Q4`.
`static ChronoElement<Integer>`	`YEAR` Element with the proleptic iso-year without any era reference and the value range `-999999999` until `999999999`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PlainDate`	`atDayOfQuarter(int dayOfQuarter)` Combines this calendar quarter with given day of quarter year to a calendar date.
`PlainDate`	`atEndOfQuarter()` Yields the date of the end of this quarter year.
`static Chronology<CalendarQuarter>`	`chronology()` Yields the associated chronology.
`int`	`compareTo(CalendarQuarter other)`
`boolean`	`contains(PlainDate temporal)` Queries if given time point belongs to this interval.
`boolean`	`equals(Object obj)`
`static CalendarQuarter`	`from(GregorianDate date)` Converts given gregorian date to a quarter year.
`Boundary<PlainDate>`	`getEnd()` Yields the upper bound of this interval.
`Quarter`	`getQuarter()` Yields the quarter year.
`Boundary<PlainDate>`	`getStart()` Yields the lower bound of this interval.
`int`	`getYear()` Yields the year number.
`int`	`hashCode()`
`boolean`	`isAfter(PlainDate temporal)` Is this interval after the given time point?
`boolean`	`isBefore(PlainDate temporal)` Is this interval before the given time point?
`Iterator<PlainDate>`	`iterator()` Iterates over all days of this calendar quarter year.
`int`	`length()` Ermittelt die Anzahl der Tage, die zu diesem Kalenderquartal gehören.
`CalendarQuarter`	`minus(Quarters quarters)` Subtracts given quarter years from this quarter year.
`CalendarQuarter`	`minus(Years<CalendarUnit> years)` Subtracts given years from this quarter year.
`static CalendarQuarter`	`nowInSystemTime()` Obtains the current calendar quarter year in system time.
`static CalendarQuarter`	`of(int year, Quarter quarter)` Creates a new instance based on given gregorian calendar year and quarter year.
`CalendarQuarter`	`plus(Quarters quarters)` Adds given quarter years to this quarter year.
`CalendarQuarter`	`plus(Years<CalendarUnit> years)` Adds given years to this quarter year.
`String`	`toString()` Outputs this instance as a String in CLDR-format "uuuu-'Q'Q" (like "2016-Q1").

Methods inherited from class net.time4j.range.FixedCalendarInterval
abuts, contains, isBefore, isEmpty, isFinite, isSimultaneous, streamDaily, toFlexInterval, withValue

Methods inherited from class net.time4j.engine.ChronoEntity
contains, get, get, getInt, getMaximum, getMinimum, getRegisteredElements, getTimezone, hasTimezone, isValid, isValid, isValid, matches, with, with, with, with

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.time4j.range.ChronoInterval
intersects, isAfter

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - YEAR
```
@FormattableElement(format="u")
public static final ChronoElement<Integer> YEAR
```
    Element with the proleptic iso-year without any era reference and the value range -999999999 until 999999999.
    
    The term "proleptic" means that the rules of the gregorian calendar and the associated way of year counting is applied backward even before the introduction of gregorian calendar. The year 0 is permitted - and negative years, too. For historic year numbers, this mathematical extrapolation is not recommended and usually wrong.
  - QUARTER_OF_YEAR
```
@FormattableElement(format="Q",
                    standalone="q")
public static final ChronoElement<Quarter> QUARTER_OF_YEAR
```
    Element with the quarter of year in the value range Q1-Q4.
- Method Detail
  - of
```
public static CalendarQuarter of(int year,
                                 Quarter quarter)
```
    Creates a new instance based on given gregorian calendar year and quarter year.
    
    Parameters:
    
    year - gregorian year within range -999,999,999 / +999,999,999
    
    quarter - quarter year
    
    Returns:
    
    new instance
    
    Throws:
    
    IllegalArgumentException - if given year is out of range
  - nowInSystemTime
```
public static CalendarQuarter nowInSystemTime()
```
    Obtains the current calendar quarter year in system time.
    
    Convenient short-cut for: SystemClock.inLocalView().now(CalendarQuarter.chronology()).
    
    Returns:
    
    current calendar quarter year in system time zone using the system clock
    
    Since:
    
    3.24/4.20
    
    See Also:
    
    SystemClock.inLocalView(), ZonalClock.now(net.time4j.engine.Chronology)
  - atDayOfQuarter
```
public PlainDate atDayOfQuarter(int dayOfQuarter)
```
    Combines this calendar quarter with given day of quarter year to a calendar date.
    
    Parameters:
    
    dayOfQuarter - day of quarter in range 1-90/91/92
    
    Returns:
    
    calendar date
    
    Throws:
    
    IllegalArgumentException - if the day-of-quarter is out of range
  - atEndOfQuarter
```
public PlainDate atEndOfQuarter()
```
    Yields the date of the end of this quarter year.
    
    Returns:
    
    PlainDate
  - getYear
```
public int getYear()
```
    Yields the year number.
    
    Returns:
    
    int
  - getQuarter
```
public Quarter getQuarter()
```
    Yields the quarter year.
    
    Returns:
    
    Quarter
  - getStart
```
public Boundary<PlainDate> getStart()
```
    Description copied from interface: ChronoInterval
    
    Yields the lower bound of this interval.
    
    Specified by:
    
    getStart in interface ChronoInterval<PlainDate>
    
    Returns:
    
    start interval boundary
  - getEnd
```
public Boundary<PlainDate> getEnd()
```
    Description copied from interface: ChronoInterval
    
    Yields the upper bound of this interval.
    
    Specified by:
    
    getEnd in interface ChronoInterval<PlainDate>
    
    Returns:
    
    end interval boundary
  - contains
```
public boolean contains(PlainDate temporal)
```
    Description copied from interface: ChronoInterval
    
    Queries if given time point belongs to this interval.
    
    Specified by:
    
    contains in interface ChronoInterval<PlainDate>
    
    Parameters:
    
    temporal - time point to be queried
    
    Returns:
    
    true if given time point belongs to this interval else false
  - isAfter
```
public boolean isAfter(PlainDate temporal)
```
    Description copied from interface: ChronoInterval
    
    Is this interval after the given time point?
    
    Specified by:
    
    isAfter in interface ChronoInterval<PlainDate>
    
    Parameters:
    
    temporal - reference time point
    
    Returns:
    
    true if this interval is after given time point else false
  - isBefore
```
public boolean isBefore(PlainDate temporal)
```
    Description copied from interface: ChronoInterval
    
    Is this interval before the given time point?
    
    Specified by:
    
    isBefore in interface ChronoInterval<PlainDate>
    
    Parameters:
    
    temporal - reference time point
    
    Returns:
    
    true if this interval is before given time point else false
  - length
```
public int length()
```
    Ermittelt die Anzahl der Tage, die zu diesem Kalenderquartal gehören.
    
    Returns:
    
    int
  - from
```
public static CalendarQuarter from(GregorianDate date)
```
    Converts given gregorian date to a quarter year.
    
    Parameters:
    
    date - gregorian calendar date (for example PlainDate
    
    Returns:
    
    CalendarQuarter
    
    Throws:
    
    IllegalArgumentException - if given date is invalid
    
    Since:
    
    3.28/4.24
  - plus
```
public CalendarQuarter plus(Years<CalendarUnit> years)
```
    Adds given years to this quarter year.
    
    Parameters:
    
    years - the count of years to be added
    
    Returns:
    
    result of addition
  - plus
```
public CalendarQuarter plus(Quarters quarters)
```
    Adds given quarter years to this quarter year.
    
    Parameters:
    
    quarters - the count of quarter years to be added
    
    Returns:
    
    result of addition
  - minus
```
public CalendarQuarter minus(Years<CalendarUnit> years)
```
    Subtracts given years from this quarter year.
    
    Parameters:
    
    years - the count of years to be subtracted
    
    Returns:
    
    result of subtraction
  - minus
```
public CalendarQuarter minus(Quarters quarters)
```
    Subtracts given quarter years from this quarter year.
    
    Parameters:
    
    quarters - the count of quarter years to be subtracted
    
    Returns:
    
    result of subtraction
  - compareTo
```
public int compareTo(CalendarQuarter other)
```
    Specified by:
    
    compareTo in interface Comparable<CalendarQuarter>
  - iterator
```
public Iterator<PlainDate> iterator()
```
    Iterates over all days of this calendar quarter year.
    
    Specified by:
    
    iterator in interface Iterable<PlainDate>
    
    Returns:
    
    Iterator
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Outputs this instance as a String in CLDR-format "uuuu-'Q'Q" (like "2016-Q1").
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String
  - chronology
```
public static Chronology<CalendarQuarter> chronology()
```
    Yields the associated chronology.
    
    Returns:
    
    the underlying rule engine

Class CalendarQuarter

Field Summary

Method Summary

Methods inherited from class net.time4j.range.FixedCalendarInterval

Methods inherited from class net.time4j.engine.ChronoEntity

Methods inherited from class java.lang.Object

Methods inherited from interface net.time4j.range.ChronoInterval

Methods inherited from interface java.lang.Iterable

Field Detail

YEAR

QUARTER_OF_YEAR

Method Detail

of

nowInSystemTime

atDayOfQuarter

atEndOfQuarter

getYear

getQuarter

getStart

getEnd

contains

isAfter

isBefore

length

from

plus

plus

minus

minus

compareTo

iterator

equals

hashCode

toString

chronology