jdk.time.Year — clojure-interop/java.time 1.0.5

A year in the ISO-8601 calendar system, such as 2007.

Year is an immutable date-time object that represents a year. Any field that can be derived from a year can be obtained.

Note that years in the ISO chronology only align with years in the Gregorian-Julian system for modern years. Parts of Russia did not switch to the modern Gregorian/ISO rules until 1920. As such, historical years must be treated with caution.

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

Years represented by this class follow the ISO-8601 standard and use the proleptic numbering system. Year 1 is preceded by year 0, then by year -1.

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.

This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of Year may have unpredictable results and should be avoided. The equals method should be used for comparisons.

*-max-value clj

Static Constant.

The maximum supported year, '+999,999,999'.

type: int

*-min-value clj

Static Constant.

The minimum supported year, '-999,999,999'.

type: int

*from clj

(*from temporal)

Obtains an instance of Year from a temporal object.

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

The conversion extracts the 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 as a query via method reference, Year::from.

temporal - the temporal object to convert, not null - java.time.temporal.TemporalAccessor

returns: the year, not null - java.time.Year

throws: java.time.DateTimeException - if unable to convert to a Year

*leap? clj

(*leap? year)

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.

year - the year to check - long

returns: true if the year is leap, false otherwise - boolean

*now clj

(*now)

(*now zone)

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

This will query the system clock to obtain the current year. 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.

zone - the zone ID to use, not null - java.time.ZoneId

returns: the current year using the system clock, not null - java.time.Year

*of clj

(*of iso-year)

Obtains an instance of Year.

This method accepts a year value from the proleptic ISO calendar system.

The year 2AD/CE is represented by 2. The year 1AD/CE is represented by 1. The year 1BC/BCE is represented by 0. The year 2BC/BCE is represented by -1.

iso-year - the ISO proleptic year to represent, from MIN_VALUE to MAX_VALUE - int

returns: the year, not null - java.time.Year

throws: java.time.DateTimeException - if the field is invalid

*parse clj

(*parse text)

(*parse text formatter)

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

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

text - the text to parse, not null - java.lang.CharSequence formatter - the formatter to use, not null - java.time.format.DateTimeFormatter

returns: the parsed year, not null - java.time.Year

throws: java.time.format.DateTimeParseException - if the text cannot be parsed

adjust-into clj

(adjust-into this temporal)

Adjusts the specified temporal object to have this year.

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

The adjustment is equivalent to using Temporal.with(TemporalField, long) passing ChronoField.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 = thisYear.adjustInto(temporal); temporal = temporal.with(thisYear);

This instance is immutable and unaffected by this method call.

temporal - the target object to be adjusted, not null - java.time.temporal.Temporal

returns: the adjusted object, not null - java.time.temporal.Temporal

throws: java.time.DateTimeException - if unable to make the adjustment

after? clj

(after? this other)

Checks if this year is after the specified year.

other - the other year to compare to, not null - java.time.Year

returns: true if this is after the specified year - boolean

at-day clj

(at-day this day-of-year)

Combines this year with a day-of-year to create a LocalDate.

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

The day-of-year value 366 is only valid in a leap year.

day-of-year - the day-of-year to use, from 1 to 365-366 - int

returns: the local date formed from this year and the specified date of year, not null - java.time.LocalDate

throws: java.time.DateTimeException - if the day of year is zero or less, 366 or greater or equal to 366 and this is not a leap year

at-month clj

(at-month this month)

Combines this year with a month to create a YearMonth.

This returns a YearMonth formed from this year and the specified month. All possible combinations of year and month are valid.

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

LocalDate date = year.atMonth(month).atDay(day);

month - the month-of-year to use, not null - java.time.Month

returns: the year-month formed from this year and the specified month, not null - java.time.YearMonth

at-month-day clj

(at-month-day this month-day)

Combines this year with a month-day to create a LocalDate.

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

A month-day of February 29th will be adjusted to February 28th in the resulting date if the year is not a leap year.

month-day - the month-day to use, not null - java.time.MonthDay

returns: the local date formed from this year and the specified month-day, not null - java.time.LocalDate

before? clj

(before? this other)

Checks if this year is before the specified year.

other - the other year to compare to, not null - java.time.Year

returns: true if this point is before the specified year - boolean

compare-to clj

(compare-to this other)

Compares this year to another year.

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

other - the other year to compare to, not null - java.time.Year

returns: the comparator value, negative if less, positive if greater - int

equals clj

(equals this obj)

Checks if this year is equal to another year.

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

obj - the object to check, null returns false - java.lang.Object

returns: true if this is equal to the other year - boolean

format clj

(format this formatter)

Formats this year using the specified formatter.

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

formatter - the formatter to use, not null - java.time.format.DateTimeFormatter

returns: the formatted year string, not null - java.lang.String

throws: java.time.DateTimeException - if an error occurs during printing

get clj

(get this field)

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

This queries this year for the value of 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. 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.

field - the field to get, not null - java.time.temporal.TemporalField

returns: the value for the field - int

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

get-long clj

(get-long this field)

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

This queries this year for the value of 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. 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.

field - the field to get, not null - java.time.temporal.TemporalField

returns: the value for the field - long

throws: java.time.DateTimeException - if a value for the field cannot be obtained

get-value clj

(get-value this)

Gets the year value.

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

returns: the year, MIN_VALUE to MAX_VALUE - int

hash-code clj

(hash-code this)

A hash code for this year.

returns: a suitable hash code - int

leap? clj

(leap? this)

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

length clj

(length this)

Gets the length of this year in days.

returns: the length of this year in days, 365 or 366 - int

minus clj

(minus this amount-to-subtract)

(minus this amount-to-subtract unit)

Returns a copy of this year with the specified amount subtracted.

This returns a Year, 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.

amount-to-subtract - the amount of the unit to subtract from the result, may be negative - long unit - the unit of the amount to subtract, not null - java.time.temporal.TemporalUnit

returns: a Year based on this year with the specified amount subtracted, not null - java.time.Year

throws: java.time.DateTimeException - if the subtraction cannot be made

minus-years clj

(minus-years this years-to-subtract)

Returns a copy of this Year with the specified number of years subtracted.

This instance is immutable and unaffected by this method call.

years-to-subtract - the years to subtract, may be negative - long

returns: a Year based on this year with the year subtracted, not null - java.time.Year

throws: java.time.DateTimeException - if the result exceeds the supported range

plus clj

(plus this amount-to-add)

(plus this amount-to-add unit)

Returns a copy of this year with the specified amount added.

This returns a Year, 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:

YEARS - Returns a Year with the specified number of years added. This is equivalent to plusYears(long). DECADES - Returns a Year with the specified number of decades added. This is equivalent to calling plusYears(long) with the amount multiplied by 10. CENTURIES - Returns a Year with the specified number of centuries added. This is equivalent to calling plusYears(long) with the amount multiplied by 100. MILLENNIA - Returns a Year with the specified number of millennia added. This is equivalent to calling plusYears(long) with the amount multiplied by 1,000. ERAS - Returns a Year 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.

amount-to-add - the amount of the unit to add to the result, may be negative - long unit - the unit of the amount to add, not null - java.time.temporal.TemporalUnit

returns: a Year based on this year with the specified amount added, not null - java.time.Year

throws: java.time.DateTimeException - if the addition cannot be made

plus-years clj

(plus-years this years-to-add)

Returns a copy of this Year with the specified number of years added.

This instance is immutable and unaffected by this method call.

years-to-add - the years to add, may be negative - long

returns: a Year based on this year with the years added, not null - java.time.Year

throws: java.time.DateTimeException - if the result exceeds the supported range

query clj

(query this query)

Queries this year using the specified query.

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

query - the query to invoke, not null - java.time.temporal.TemporalQuery

returns: the query result, null may be returned (defined by the query) - <R> R

throws: java.time.DateTimeException - if unable to query (defined by the query)

range clj

(range this 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 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.

field - the field to query the range for, not null - java.time.temporal.TemporalField

returns: the range of valid values for the field, not null - java.time.temporal.ValueRange

throws: java.time.DateTimeException - if the range for the field cannot be obtained

supported? clj

(supported? this field)

Checks if the specified field is supported.

This checks if this year 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:

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.

field - the field to check, null returns false - java.time.temporal.TemporalField

returns: true if the field is supported on this year, false if not - boolean

to-string clj

(to-string this)

Outputs this year as a String.

returns: a string representation of this year, not null - java.lang.String

until clj

(until this end-exclusive unit)

Calculates the amount of time until another year in terms of the specified unit.

This calculates the amount of time between two Year objects in terms of a single TemporalUnit. The start and end points are this and the specified year. The result will be negative if the end is before the start. The Temporal passed to this method is converted to a Year using from(TemporalAccessor). For example, the amount in decades between two year can be calculated using startYear.until(endYear, DECADES).

The calculation returns a whole number, representing the number of complete units between the two years. For example, the amount in decades between 2012 and 2031 will only be one decade as it is one year 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, YEARS); amount = 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 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.

end-exclusive - the end date, exclusive, which is converted to a Year, not null - java.time.temporal.Temporal unit - the unit to measure the amount in, not null - java.time.temporal.TemporalUnit

returns: the amount of time between this year and the end year - long

throws: java.time.DateTimeException - if the amount cannot be calculated, or the end temporal cannot be converted to a Year

valid-month-day? clj

(valid-month-day? this month-day)

Checks if the month-day is valid for this year.

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

month-day - the month-day to validate, null returns false - java.time.MonthDay

returns: true if the month and day are valid for this year - boolean

with clj

(with this adjuster)

(with this field new-value)

Returns a copy of this year with the specified field set to a new value.

This returns a Year, based on this one, with the value for the specified field changed. 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:

YEAR_OF_ERA - Returns a Year with the specified year-of-era The era will be unchanged. YEAR - Returns a Year with the specified year. This completely replaces the date and is equivalent to of(int). ERA - Returns a Year with the specified era. The 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.

field - the field to set in the result, not null - java.time.temporal.TemporalField new-value - the new value of the field in the result - long

returns: a Year based on this with the specified field set, not null - java.time.Year

throws: java.time.DateTimeException - if the field cannot be set