Package net.time4j.range

Class CalendarYear

java.lang.Object

net.time4j.engine.ChronoEntity<T>

net.time4j.range.FixedCalendarInterval<CalendarYear>

net.time4j.range.CalendarYear

All Implemented Interfaces:

Serializable, Comparable<CalendarYear>, Iterable<PlainDate>, TemporalAccessor, ChronoDisplay, ThreetenAdapter, LocalizedPatternSupport, ChronoInterval<PlainDate>

@CalendarType("iso8601")
public final class CalendarYear
extends FixedCalendarInterval<CalendarYear>
implements ThreetenAdapter, LocalizedPatternSupport

Represents a full gregorian calendar year as interval from 1st of January until end of December.

The only element which is registered by this class is:

• YEAR

Note: The current calendar year can be determined by an expression like: nowInSystemTime() or in a more general way CalendarYear current = SystemClock.inLocalView().now(CalendarYear.chronology()).

Since:

3.21/4.17

Author:

Meno Hochschild

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ChronoElement<Integer>	YEAR	Element with the proleptic iso-year without any era reference and the value range -999999999 until 999999999.

Method Summary

Modifier and Type	Method	Description
CalendarMonth	at(Month month)	Combines this year with given month to a calendar month.
CalendarQuarter	at(Quarter quarter)	Combines this year with given quarter year to a calendar quarter.
PlainDate	atDayOfYear(int dayOfYear)	Combines this year with given day of year to a calendar date.
CalendarMonth	atMonth(int month)	Combines this year with given month to a calendar month.
static Chronology<CalendarYear>	chronology()	Yields the associated chronology.
int	compareTo(CalendarYear other)
boolean	contains(PlainDate temporal)	Queries if given time point belongs to this interval.
boolean	equals(Object obj)
static CalendarYear	from(Year year)	Converts given JSR-310-type to a calendar year.
static CalendarYear	from(GregorianDate date)	Converts given gregorian date to a calendar year.
Boundary<PlainDate>	getEnd()	Yields the upper bound of this interval.
Boundary<PlainDate>	getStart()	Yields the lower bound of this interval.
int	getValue()	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?
boolean	isLeap()	Determines if this calendar year is a leap year with 366 days.
Iterator<PlainDate>	iterator()	Iterates over all days of this year.
int	length()	Determines the count of days belonging to this year.
CalendarYear	minus(Years<CalendarUnit> years)	Subtracts given years from this year.
static CalendarYear	nowInSystemTime()	Obtains the current calendar year in system time.
static CalendarYear	of(int year)	Creates a new instance based on given gregorian calendar year.
CalendarYear	plus(Years<CalendarUnit> years)	Adds given years to this year.
static Chronology<Year>	threeten()	Obtains a bridge chronology for the type java.time.Year.
static TimeLine<CalendarYear>	timeline()	Obtains a timeline for this type.
String	toString()	Outputs this year number as a String in CLDR-format "uuuu".
Year	toTemporalAccessor()	Converts this object to a TemporalAccessor.

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

Methods inherited from interface net.time4j.format.LocalizedPatternSupport

getFormatPattern, getFormatPattern, useDynamicFormatPattern

Methods inherited from interface net.time4j.engine.ThreetenAdapter

get, getLong, isSupported, query, range

Field Details

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.

Format pattern symbol (for CLDR standard) can be either "u" or "y". Format example for Japanese:

     ChronoFormatter<CalendarYear> f =
       ChronoFormatter.ofStyle(DisplayMode.FULL, Locale.JAPANESE, CalendarYear.chronology());
     CalendarYear cyear = CalendarYear.of(2016);
     System.out.println(f.format(cyear)); // 2016年
 

Method Details

of

public static CalendarYear of(int year)

Creates a new instance based on given gregorian calendar year.

Parameters:

year - gregorian year within range -999,999,999 / +999,999,999

Returns:

new instance

Throws:

IllegalArgumentException - if given argument is out of range

nowInSystemTime

public static CalendarYear nowInSystemTime()

Obtains the current calendar year in system time.

Convenient short-cut for: SystemClock.inLocalView().now(CalendarYear.chronology()).

Returns:

current calendar year in system time zone using the system clock

Since:

3.24/4.20

See Also:

SystemClock.inLocalView(), ZonalClock.now(net.time4j.engine.Chronology)

at

public CalendarQuarter at(Quarter quarter)

Combines this year with given quarter year to a calendar quarter.

Parameters:

quarter - quarter year

Returns:

calendar quarter

at

public CalendarMonth at(Month month)

Combines this year with given month to a calendar month.

Parameters:

month - gregorian month

Returns:

calendar month

atMonth

public CalendarMonth atMonth(int month)

Combines this year with given month to a calendar month.

Parameters:

month - gregorian month in range 1-12

Returns:

calendar month

Throws:

IllegalArgumentException - if the month is out of range

atDayOfYear

public PlainDate atDayOfYear(int dayOfYear)

Combines this year with given day of year to a calendar date.

Parameters:

dayOfYear - day of year in range 1-365/366

Returns:

calendar date

Throws:

IllegalArgumentException - if the day-of-year is out of range

getValue

public int getValue()

Yields the year number.

Returns:

int

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

isLeap

public boolean isLeap()

Determines if this calendar year is a leap year with 366 days.

Returns:

true if it is a leap year else false

See Also:

GregorianMath.isLeapYear(int)

length

public int length()

Determines the count of days belonging to this year.

Returns:

int

See Also:

isLeap()

from

public static CalendarYear from(GregorianDate date)

Converts given gregorian date to a calendar year.

Parameters:

date - gregorian calendar date (for example PlainDate

Returns:

CalendarYear

Throws:

IllegalArgumentException - if given date is invalid

Since:

3.28/4.24

from

public static CalendarYear from(Year year)

Converts given JSR-310-type to a calendar year.

Parameters:

year - Threeten-equivalent of this instance

Returns:

CalendarYear

See Also:

toTemporalAccessor()

plus

public CalendarYear plus(Years<CalendarUnit> years)

Adds given years to this year.

Parameters:

years - the count of years to be added

Returns:

result of addition

minus

public CalendarYear minus(Years<CalendarUnit> years)

Subtracts given years from this year.

Parameters:

years - the count of years to be subtracted

Returns:

result of subtraction

compareTo

public int compareTo(CalendarYear other)

Specified by:

compareTo in interface Comparable<CalendarYear>

iterator

public Iterator<PlainDate> iterator()

Iterates over all days of this 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 year number as a String in CLDR-format "uuuu".

Overrides:

toString in class Object

Returns:

String

toTemporalAccessor

public Year toTemporalAccessor()

Description copied from interface: ThreetenAdapter

Converts this object to a TemporalAccessor.

Any implementation is required to return a new object with a different concrete type, not this instance.

Specified by:

toTemporalAccessor in interface ThreetenAdapter

Returns:

converted Threeten-object (always as new object)

chronology

public static Chronology<CalendarYear> chronology()

Yields the associated chronology.

Returns:

the underlying rule engine

threeten

public static Chronology<Year> threeten()

Obtains a bridge chronology for the type java.time.Year.

Returns:

rule engine adapted for the type java.time.Year

See Also:

chronology()

timeline

public static TimeLine<CalendarYear> timeline()

Obtains a timeline for this type.

Returns:

singleton timeline

Since:

5.0