OpenJDK 1.22 · java.time.Year · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final int	MAX_VALUE The maximum supported year, '+999,999,999'.
public static final int	MIN_VALUE The minimum supported year, '-999,999,999'.
private static final DateTimeFormatter	PARSER Parser.
private static final long	serialVersionUID Serialization version.
private final int	year The year being represented.

Access	Constructor and Description
private	Year(int the year to represent year) Constructor.

Method Summary

Modifier and Type	Method and Description
public Temporal	Returns: the adjusted object, not null adjustInto(Temporal the target object to be adjusted, not null temporal) Implements java.time.temporal.TemporalAdjuster.adjustInto. Adjusts the specified temporal object to have this year.
public LocalDate	Returns: the local date formed from this year and the specified date of year, not null atDay(int the day-of-year to use, from 1 to 365-366 dayOfYear) Combines this year with a day-of-year to create a `LocalDate`.
public YearMonth	Returns: the year-month formed from this year and the specified month, not null atMonth(Month the month-of-year to use, not null month) Combines this year with a month to create a `YearMonth`.
public YearMonth	Returns: the year-month formed from this year and the specified month, not null atMonth(int the month-of-year to use, from 1 (January) to 12 (December) month) Combines this year with a month to create a `YearMonth`.
public LocalDate	Returns: the local date formed from this year and the specified month-day, not null atMonthDay(MonthDay the month-day to use, not null monthDay) Combines this year with a month-day to create a `LocalDate`.
public int	Returns: the comparator value, that is less than zero if this is before `other`, zero if they are equal, or greater than zero if this is after `other` compareTo(Year the other year to compare to, not null other) Implements java.lang.Comparable.compareTo. Compares this year to another year.
public boolean	Returns: true if this is equal to the other year equals(Object the object to check, null returns false obj) Overrides java.lang.Object.equals. Checks if this year is equal to another year.
public String	Returns: the formatted year string, not null format(DateTimeFormatter the formatter to use, not null formatter) Formats this year using the specified formatter.
public static Year	Returns: the year, not null from(TemporalAccessor the temporal object to convert, not null temporal) Obtains an instance of `Year` from a temporal object.
public int	Returns: the value for the field get(TemporalField the field to get, not null field) Overrides default java.time.temporal.TemporalAccessor.get. Gets the value of the specified field from this year as an `int`.
public long	Returns: the value for the field getLong(TemporalField the field to get, not null field) Implements java.time.temporal.TemporalAccessor.getLong. Gets the value of the specified field from this year as a `long`.
public int	Returns: the year, `MIN_VALUE` to `MAX_VALUE` getValue() Gets the year value.
public int	Returns: a suitable hash code hashCode() Overrides java.lang.Object.hashCode. A hash code for this year.
public boolean	Returns: true if this is after the specified year isAfter(Year the other year to compare to, not null other) Checks if this year is after the specified year.
public boolean	Returns: true if this point is before the specified year isBefore(Year the other year to compare to, not null other) Checks if this year is before the specified year.
public static boolean	Returns: true if the year is leap, false otherwise isLeap(long the year to check year) Checks if the year is a leap year, according to the ISO proleptic calendar system rules.
public boolean	Returns: true if the year is leap, false otherwise isLeap() Checks if the year is a leap year, according to the ISO proleptic calendar system rules.
public boolean	Returns: true if the field is supported on this year, false if not isSupported(TemporalField the field to check, null returns false field) Implements java.time.temporal.TemporalAccessor.isSupported. Checks if the specified field is supported.
public boolean	Returns: true if the unit can be added/subtracted, false if not isSupported(TemporalUnit the unit to check, null returns false unit) Implements java.time.temporal.Temporal.isSupported. Checks if the specified unit is supported.
public boolean	Returns: true if the month and day are valid for this year isValidMonthDay(MonthDay the month-day to validate, null returns false monthDay) Checks if the month-day is valid for this year.
public int	Returns: the length of this year in days, 365 or 366 length() Gets the length of this year in days.
public Year	Returns: a `Year` based on this year with the subtraction made, not null minus(TemporalAmount the amount to subtract, not null amountToSubtract) Overrides default java.time.temporal.Temporal.minus. Returns a copy of this year with the specified amount subtracted.
public Year	Returns: a `Year` based on this year with the specified amount subtracted, not null minus(long the amount of the unit to subtract from the result, may be negative amountToSubtract, TemporalUnit the unit of the amount to subtract, not null unit) Overrides default java.time.temporal.Temporal.minus. Returns a copy of this year with the specified amount subtracted.
public Year	Returns: a `Year` based on this year with the year subtracted, not null minusYears(long the years to subtract, may be negative yearsToSubtract) Returns a copy of this `Year` with the specified number of years subtracted.
public static Year	Returns: the current year using the system clock and default time-zone, not null now() Obtains the current year from the system clock in the default time-zone.
public static Year	Returns: the current year using the system clock, not null now(ZoneId the zone ID to use, not null zone) Obtains the current year from the system clock in the specified time-zone.
public static Year	Returns: the current year, not null now(Clock the clock to use, not null clock) Obtains the current year from the specified clock.
public static Year	Returns: the year, not null of(int the ISO proleptic year to represent, from `MIN_VALUE` to `MAX_VALUE` isoYear) Obtains an instance of `Year`.
public static Year	Returns: the parsed year, not null parse(CharSequence the text to parse such as "2007", not null text) Obtains an instance of `Year` from a text string such as `2007`.
public static Year	Returns: the parsed year, not null parse(CharSequence the text to parse, not null text, DateTimeFormatter the formatter to use, not null formatter) Obtains an instance of `Year` from a text string using a specific formatter.
public Year	Returns: a `Year` based on this year with the addition made, not null plus(TemporalAmount the amount to add, not null amountToAdd) Overrides default java.time.temporal.Temporal.plus. Returns a copy of this year with the specified amount added.
public Year	Returns: a `Year` based on this year with the specified amount added, not null plus(long the amount of the unit to add to the result, may be negative amountToAdd, TemporalUnit the unit of the amount to add, not null unit) Implements java.time.temporal.Temporal.plus. Returns a copy of this year with the specified amount added.
public Year	Returns: a `Year` based on this year with the years added, not null plusYears(long the years to add, may be negative yearsToAdd) Returns a copy of this `Year` with the specified number of years added.
public < the type of the result R> R	Returns: the query result, null may be returned (defined by the query) query(TemporalQuery<R> the query to invoke, not null query) Overrides default java.time.temporal.TemporalAccessor.query. Queries this year using the specified query.
public ValueRange	Returns: the range of valid values for the field, not null range(TemporalField the field to query the range for, not null field) Overrides default java.time.temporal.TemporalAccessor.range. Gets the range of valid values for the specified field.
pack-priv static Year	readExternal(DataInput in)
private void	readObject(ObjectInputStream the stream to read s) Defend against malicious streams.
public String	Returns: a string representation of this year, not null toString() Overrides java.lang.Object.toString. Outputs this year as a `String`.
public long	Returns: the amount of time between this year and the end year until(Temporal the end date, exclusive, which is converted to a `Year`, not null endExclusive, TemporalUnit the unit to measure the amount in, not null unit) Implements java.time.temporal.Temporal.until. Calculates the amount of time until another year in terms of the specified unit.
public Year	Returns: a `Year` based on `this` with the adjustment made, not null with(TemporalAdjuster the adjuster to use, not null adjuster) Overrides default java.time.temporal.Temporal.with. Returns an adjusted copy of this year.
public Year	Returns: a `Year` based on `this` with the specified field set, not null with(TemporalField the field to set in the result, not null field, long the new value of the field in the result newValue) Implements java.time.temporal.Temporal.with. Returns a copy of this year with the specified field set to a new value.
pack-priv void	writeExternal(DataOutput out)
private Object	Returns: the instance of `Ser`, not null writeReplace() Writes the object using a dedicated serialized form.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

MAX_VALUE	back to summary
public static final int MAX_VALUE The maximum supported year, '+999,999,999'.

MIN_VALUE	back to summary
public static final int MIN_VALUE The minimum supported year, '-999,999,999'.

PARSER	back to summary
private static final DateTimeFormatter PARSER Parser.

serialVersionUID	back to summary
private static final long serialVersionUID Serialization version. Annotations @Serial

year	back to summary
private final int year The year being represented.

Year	back to summary
private Year(int year) Constructor. Parameters year:int the year to represent

Method Detail

adjustInto back to summary

adjustInto	back to summary
public Temporal adjustInto(Temporal temporal) Implements java.time.temporal.TemporalAdjuster.adjustInto. 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. 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

public Temporal adjustInto(Temporal temporal)

Implements java.time.temporal.TemporalAdjuster.adjustInto.

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.

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

atDay back to summary

atDay	back to summary
public LocalDate atDay(int dayOfYear) 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. Parameters dayOfYear:int the day-of-year to use, from 1 to 365-366 Returns:LocalDate the local date formed from this year and the specified date of year, not null Exceptions DateTimeException: if the day of year is zero or less, 366 or greater or equal to 366 and this is not a leap year

public LocalDate atDay(int dayOfYear)

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.

Parameters

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

Returns:LocalDate

the local date formed from this year and the specified date of year, not null

Exceptions

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

atMonth back to summary

atMonth	back to summary
public YearMonth atMonth(Month 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); Parameters month:Month the month-of-year to use, not null Returns:YearMonth the year-month formed from this year and the specified month, not null

public YearMonth atMonth(Month 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);

Parameters

month:Month: the month-of-year to use, not null

Returns:YearMonth

the year-month formed from this year and the specified month, not null

atMonth back to summary

atMonth	back to summary
public YearMonth atMonth(int 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); Parameters month:int the month-of-year to use, from 1 (January) to 12 (December) Returns:YearMonth the year-month formed from this year and the specified month, not null Exceptions DateTimeException: if the month is invalid

public YearMonth atMonth(int 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);

Parameters

month:int: the month-of-year to use, from 1 (January) to 12 (December)

Returns:YearMonth

the year-month formed from this year and the specified month, not null

Exceptions

DateTimeException:: if the month is invalid

atMonthDay back to summary

atMonthDay	back to summary
public LocalDate atMonthDay(MonthDay monthDay) 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. Parameters monthDay:MonthDay the month-day to use, not null Returns:LocalDate the local date formed from this year and the specified month-day, not null

public LocalDate atMonthDay(MonthDay monthDay)

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.

Parameters

monthDay:MonthDay: the month-day to use, not null

Returns:LocalDate

the local date formed from this year and the specified month-day, not null

compareTo back to summary

compareTo	back to summary
public int compareTo(Year other) Implements java.lang.Comparable.compareTo. 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`. Parameters other:Year the other year to compare to, not null Returns:int the comparator value, that is less than zero if this is before `other`, zero if they are equal, or greater than zero if this is after `other` Annotations @Override See Also `isBefore`, `isAfter`

public int compareTo(Year other)

Implements java.lang.Comparable.compareTo.

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.

Parameters

other:Year: the other year to compare to, not null

Returns:int

the comparator value, that is less than zero if this is before other, zero if they are equal, or greater than zero if this is after other

Annotations

@Override

See Also

isBefore, isAfter

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Checks if this year is equal to another year. The comparison is based on the time-line position of the years. Parameters obj:Object the object to check, null returns false Returns:boolean true if this is equal to the other year Annotations @Override

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Checks if this year is equal to another year.

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

Parameters

obj:Object: the object to check, null returns false

Returns:boolean

true if this is equal to the other year

Annotations

@Override

format	back to summary
public String format(DateTimeFormatter formatter) Formats this year using the specified formatter. This year will be passed to the formatter to produce a string. Parameters formatter:DateTimeFormatter the formatter to use, not null Returns:String the formatted year string, not null Exceptions DateTimeException: if an error occurs during printing

format

back to summary

public String format(DateTimeFormatter formatter)

Formats this year using the specified formatter.

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

Parameters

formatter:DateTimeFormatter: the formatter to use, not null

Returns:String

the formatted year string, not null

Exceptions

DateTimeException:: if an error occurs during printing

from back to summary

from	back to summary
public static Year from(TemporalAccessor 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`. Parameters temporal:TemporalAccessor the temporal object to convert, not null Returns:Year the year, not null Exceptions DateTimeException: if unable to convert to a `Year`

public static Year from(TemporalAccessor 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.

Parameters

temporal:TemporalAccessor: the temporal object to convert, not null

Returns:Year

the year, not null

Exceptions

DateTimeException:: if unable to convert to a Year

get back to summary

get	back to summary
public int get(TemporalField field) Overrides default java.time.temporal.TemporalAccessor.get. 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. Parameters field:TemporalField the field to get, not null Returns:int the value for the field 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

public int get(TemporalField field)

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

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.

Parameters

field:TemporalField: the field to get, not null

Returns:int

the value for the field

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

getLong back to summary

getLong	back to summary
public long getLong(TemporalField field) Implements java.time.temporal.TemporalAccessor.getLong. 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. 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

public long getLong(TemporalField field)

Implements java.time.temporal.TemporalAccessor.getLong.

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.

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

getValue back to summary

getValue	back to summary
public int getValue() Gets the year value. The year returned by this method is proleptic as per `get(YEAR)`. Returns:int the year, `MIN_VALUE` to `MAX_VALUE`

public int getValue()

Gets the year value.

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

Returns:int: the year, MIN_VALUE to MAX_VALUE

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. A hash code for this year. Returns:int a suitable hash code Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

A hash code for this year.

Returns:int

a suitable hash code

Annotations

@Override

isAfter	back to summary
public boolean isAfter(Year other) Checks if this year is after the specified year. Parameters other:Year the other year to compare to, not null Returns:boolean true if this is after the specified year

isAfter

back to summary

public boolean isAfter(Year other)

Checks if this year is after the specified year.

Parameters

other:Year: the other year to compare to, not null

Returns:boolean

true if this is after the specified year

isBefore	back to summary
public boolean isBefore(Year other) Checks if this year is before the specified year. Parameters other:Year the other year to compare to, not null Returns:boolean true if this point is before the specified year

isBefore

back to summary

public boolean isBefore(Year other)

Checks if this year is before the specified year.

Parameters

other:Year: the other year to compare to, not null

Returns:boolean

true if this point is before the specified year

isLeap	back to summary
public static boolean isLeap(long 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. Parameters year:long the year to check Returns:boolean true if the year is leap, false otherwise

isLeap

back to summary

public static boolean isLeap(long 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.

Parameters

year:long: the year to check

Returns:boolean

true if the year is leap, false otherwise

isLeap	back to summary
public boolean isLeap() 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:boolean true if the year is leap, false otherwise

isLeap

back to summary

public boolean isLeap()

Checks if the year is a leap year, according to the ISO proleptic calendar system rules.

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:boolean: true if the year is leap, false otherwise

isSupported back to summary

isSupported	back to summary
public boolean isSupported(TemporalField field) Implements java.time.temporal.TemporalAccessor.isSupported. 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. Parameters field:TemporalField the field to check, null returns false Returns:boolean true if the field is supported on this year, false if not Annotations @Override

public boolean isSupported(TemporalField field)

Implements java.time.temporal.TemporalAccessor.isSupported.

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.

Parameters

field:TemporalField: the field to check, null returns false

Returns:boolean

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

Annotations

@Override

isSupported back to summary

isSupported	back to summary
public boolean isSupported(TemporalUnit unit) Implements java.time.temporal.Temporal.isSupported. Checks if the specified unit is supported. This checks if the specified unit can be added to, or subtracted from, this year. If false, then calling the `plus(long, TemporalUnit)` and `minus` methods will throw an exception. If the unit is a `ChronoUnit` then the query is implemented here. The supported units are: `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. Parameters unit:TemporalUnit the unit to check, null returns false Returns:boolean true if the unit can be added/subtracted, false if not Annotations @Override

public boolean isSupported(TemporalUnit unit)

Implements java.time.temporal.Temporal.isSupported.

Checks if the specified unit is supported.

This checks if the specified unit can be added to, or subtracted from, this year. If false, then calling the plus(long, TemporalUnit) and minus methods will throw an exception.

If the unit is a ChronoUnit then the query is implemented here. The supported units are:

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.

Parameters

unit:TemporalUnit: the unit to check, null returns false

Returns:boolean

true if the unit can be added/subtracted, false if not

Annotations

@Override

isValidMonthDay	back to summary
public boolean isValidMonthDay(MonthDay monthDay) 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. Parameters monthDay:MonthDay the month-day to validate, null returns false Returns:boolean true if the month and day are valid for this year

isValidMonthDay

back to summary

public boolean isValidMonthDay(MonthDay monthDay)

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.

Parameters

monthDay:MonthDay: the month-day to validate, null returns false

Returns:boolean

true if the month and day are valid for this year

length	back to summary
public int length() Gets the length of this year in days. Returns:int the length of this year in days, 365 or 366

length

back to summary

public int length()

Gets the length of this year in days.

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

minus back to summary

minus	back to summary
public Year minus(TemporalAmount amountToSubtract) Overrides default java.time.temporal.Temporal.minus. Returns a copy of this year with the specified amount subtracted. This returns a `Year`, based on this one, with the specified amount subtracted. The amount is typically `Period` but may be any other type implementing the `TemporalAmount` interface. The calculation is delegated to the amount object by calling `TemporalAmount#subtractFrom(Temporal)`. The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to `minus(long, TemporalUnit)`. Consult the documentation of the amount implementation to determine if it can be successfully subtracted. This instance is immutable and unaffected by this method call. Parameters amountToSubtract:TemporalAmount the amount to subtract, not null Returns:Year a `Year` based on this year with the subtraction made, not null Annotations @Override Exceptions DateTimeException: if the subtraction cannot be made ArithmeticException: if numeric overflow occurs

public Year minus(TemporalAmount amountToSubtract)

Overrides default java.time.temporal.Temporal.minus.

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

This returns a Year, based on this one, with the specified amount subtracted. The amount is typically Period but may be any other type implementing the TemporalAmount interface.

The calculation is delegated to the amount object by calling TemporalAmount#subtractFrom(Temporal). The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to minus(long, TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully subtracted.

This instance is immutable and unaffected by this method call.

Parameters

amountToSubtract:TemporalAmount: the amount to subtract, not null

Returns:Year

a Year based on this year with the subtraction made, not null

Annotations

@Override

Exceptions

DateTimeException:: if the subtraction cannot be made
ArithmeticException:: if numeric overflow occurs

minus back to summary

minus	back to summary
public Year minus(long amountToSubtract, TemporalUnit unit) Overrides default java.time.temporal.Temporal.minus. 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. Parameters amountToSubtract:long the amount of the unit to subtract from the result, may be negative unit:TemporalUnit the unit of the amount to subtract, not null Returns:Year a `Year` based on this year with the specified amount subtracted, not null Annotations @Override Exceptions DateTimeException: if the subtraction cannot be made UnsupportedTemporalTypeException: if the unit is not supported ArithmeticException: if numeric overflow occurs

public Year minus(long amountToSubtract, TemporalUnit unit)

Overrides default java.time.temporal.Temporal.minus.

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.

Parameters

amountToSubtract:long: the amount of the unit to subtract from the result, may be negative
unit:TemporalUnit: the unit of the amount to subtract, not null

Returns:Year

a Year based on this year with the specified amount subtracted, not null

Annotations

@Override

Exceptions

DateTimeException:: if the subtraction cannot be made
UnsupportedTemporalTypeException:: if the unit is not supported
ArithmeticException:: if numeric overflow occurs

minusYears back to summary

minusYears	back to summary
public Year minusYears(long yearsToSubtract) Returns a copy of this `Year` with the specified number of years subtracted. This instance is immutable and unaffected by this method call. Parameters yearsToSubtract:long the years to subtract, may be negative Returns:Year a `Year` based on this year with the year subtracted, not null Exceptions DateTimeException: if the result exceeds the supported range

public Year minusYears(long yearsToSubtract)

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

This instance is immutable and unaffected by this method call.

Parameters

yearsToSubtract:long: the years to subtract, may be negative

Returns:Year

a Year based on this year with the year subtracted, not null

Exceptions

DateTimeException:: if the result exceeds the supported range

now back to summary

now	back to summary
public static Year now() Obtains the current year from the system clock in the default time-zone. This will query the `system clock` in the default time-zone to obtain the current year. Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded. Returns:Year the current year using the system clock and default time-zone, not null

public static Year now()

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

This will query the system clock in the default time-zone to obtain the current year.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Returns:Year: the current year using the system clock and default time-zone, not null

now back to summary

now	back to summary
public static Year now(ZoneId 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. Parameters zone:ZoneId the zone ID to use, not null Returns:Year the current year using the system clock, not null

public static Year now(ZoneId 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.

Parameters

zone:ZoneId: the zone ID to use, not null

Returns:Year

the current year using the system clock, not null

now back to summary

now	back to summary
public static Year now(Clock clock) Obtains the current year from the specified clock. This will query the specified clock to obtain the current year. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using `dependency injection`. Parameters clock:Clock the clock to use, not null Returns:Year the current year, not null

public static Year now(Clock clock)

Obtains the current year from the specified clock.

This will query the specified clock to obtain the current year. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

Parameters

clock:Clock: the clock to use, not null

Returns:Year

the current year, not null

of back to summary

of	back to summary
public static Year of(int isoYear) 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. Parameters isoYear:int the ISO proleptic year to represent, from `MIN_VALUE` to `MAX_VALUE` Returns:Year the year, not null Exceptions DateTimeException: if the field is invalid

public static Year of(int isoYear)

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.

Parameters

isoYear:int: the ISO proleptic year to represent, from MIN_VALUE to MAX_VALUE

Returns:Year

the year, not null

Exceptions

DateTimeException:: if the field is invalid

parse back to summary

parse	back to summary
public static Year parse(CharSequence text) Obtains an instance of `Year` from a text string such as `2007`. The string must represent a valid year. Parameters text:CharSequence the text to parse such as "2007", not null Returns:Year the parsed year, not null Exceptions DateTimeParseException: if the text cannot be parsed

public static Year parse(CharSequence text)

Obtains an instance of Year from a text string such as 2007.

The string must represent a valid year.

Parameters

text:CharSequence: the text to parse such as "2007", not null

Returns:Year

the parsed year, not null

Exceptions

DateTimeParseException:: if the text cannot be parsed

parse back to summary

parse	back to summary
public static Year parse(CharSequence text, DateTimeFormatter formatter) Obtains an instance of `Year` from a text string using a specific formatter. The text is parsed using the formatter, returning a year. Parameters text:CharSequence the text to parse, not null formatter:DateTimeFormatter the formatter to use, not null Returns:Year the parsed year, not null Exceptions DateTimeParseException: if the text cannot be parsed

public static Year parse(CharSequence text, DateTimeFormatter formatter)

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

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

Parameters

text:CharSequence: the text to parse, not null
formatter:DateTimeFormatter: the formatter to use, not null

Returns:Year

the parsed year, not null

Exceptions

DateTimeParseException:: if the text cannot be parsed

plus back to summary

plus	back to summary
public Year plus(TemporalAmount amountToAdd) Overrides default java.time.temporal.Temporal.plus. Returns a copy of this year with the specified amount added. This returns a `Year`, based on this one, with the specified amount added. The amount is typically `Period` but may be any other type implementing the `TemporalAmount` interface. The calculation is delegated to the amount object by calling `TemporalAmount#addTo(Temporal)`. The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to `plus(long, TemporalUnit)`. Consult the documentation of the amount implementation to determine if it can be successfully added. This instance is immutable and unaffected by this method call. Parameters amountToAdd:TemporalAmount the amount to add, not null Returns:Year a `Year` based on this year with the addition made, not null Annotations @Override Exceptions DateTimeException: if the addition cannot be made ArithmeticException: if numeric overflow occurs

public Year plus(TemporalAmount amountToAdd)

Overrides default java.time.temporal.Temporal.plus.

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

This returns a Year, based on this one, with the specified amount added. The amount is typically Period but may be any other type implementing the TemporalAmount interface.

The calculation is delegated to the amount object by calling TemporalAmount#addTo(Temporal). The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to plus(long, TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully added.

This instance is immutable and unaffected by this method call.

Parameters

amountToAdd:TemporalAmount: the amount to add, not null

Returns:Year

a Year based on this year with the addition made, not null

Annotations

@Override

Exceptions

DateTimeException:: if the addition cannot be made
ArithmeticException:: if numeric overflow occurs

plus back to summary

plus	back to summary
public Year plus(long amountToAdd, TemporalUnit unit) Implements java.time.temporal.Temporal.plus. 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. Parameters amountToAdd:long the amount of the unit to add to the result, may be negative unit:TemporalUnit the unit of the amount to add, not null Returns:Year a `Year` based on this year with the specified amount added, not null Annotations @Override Exceptions DateTimeException: if the addition cannot be made UnsupportedTemporalTypeException: if the unit is not supported ArithmeticException: if numeric overflow occurs

public Year plus(long amountToAdd, TemporalUnit unit)

Implements java.time.temporal.Temporal.plus.

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.

Parameters

amountToAdd:long: the amount of the unit to add to the result, may be negative
unit:TemporalUnit: the unit of the amount to add, not null

Returns:Year

a Year based on this year with the specified amount added, not null

Annotations

@Override

Exceptions

DateTimeException:: if the addition cannot be made
UnsupportedTemporalTypeException:: if the unit is not supported
ArithmeticException:: if numeric overflow occurs

plusYears back to summary

plusYears	back to summary
public Year plusYears(long yearsToAdd) Returns a copy of this `Year` with the specified number of years added. This instance is immutable and unaffected by this method call. Parameters yearsToAdd:long the years to add, may be negative Returns:Year a `Year` based on this year with the years added, not null Exceptions DateTimeException: if the result exceeds the supported range

public Year plusYears(long yearsToAdd)

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

This instance is immutable and unaffected by this method call.

Parameters

yearsToAdd:long: the years to add, may be negative

Returns:Year

a Year based on this year with the years added, not null

Exceptions

DateTimeException:: if the result exceeds the supported range

query back to summary

query	back to summary
public <R> R query(TemporalQuery<R> query) Overrides default java.time.temporal.TemporalAccessor.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. 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)

public <R> R query(TemporalQuery<R> query)

Overrides default java.time.temporal.TemporalAccessor.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.

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)

range back to summary

range	back to summary
public ValueRange range(TemporalField field) 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 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. 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

public ValueRange range(TemporalField field)

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

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

readExternal	back to summary
pack-priv static Year readExternal(DataInput in) throws IOException

readObject	back to summary
private void readObject(ObjectInputStream s) throws InvalidObjectException Defend against malicious streams. Parameters s:ObjectInputStream the stream to read Annotations @Serial Exceptions InvalidObjectException: always

readObject

back to summary

private void readObject(ObjectInputStream s) throws InvalidObjectException

Defend against malicious streams.

Parameters

s:ObjectInputStream: the stream to read

Annotations

@Serial

Exceptions

InvalidObjectException:: always

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Outputs this year as a `String`. Returns:String a string representation of this year, not null Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Outputs this year as a String.

Returns:String

a string representation of this year, not null

Annotations

@Override

until back to summary

until	back to summary
public long until(Temporal endExclusive, TemporalUnit unit) Implements java.time.temporal.Temporal.until. 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. Parameters endExclusive:Temporal the end date, exclusive, which is converted to a `Year`, not null unit:TemporalUnit the unit to measure the amount in, not null Returns:long the amount of time between this year and the end year Annotations @Override Exceptions DateTimeException: if the amount cannot be calculated, or the end temporal cannot be converted to a `Year` UnsupportedTemporalTypeException: if the unit is not supported ArithmeticException: if numeric overflow occurs

public long until(Temporal endExclusive, TemporalUnit unit)

Implements java.time.temporal.Temporal.until.

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.

Parameters

endExclusive:Temporal: the end date, exclusive, which is converted to a Year, not null
unit:TemporalUnit: the unit to measure the amount in, not null

Returns:long

the amount of time between this year and the end year

Annotations

@Override

Exceptions

DateTimeException:: if the amount cannot be calculated, or the end temporal cannot be converted to a Year
UnsupportedTemporalTypeException:: if the unit is not supported
ArithmeticException:: if numeric overflow occurs

with back to summary

with	back to summary
public Year with(TemporalAdjuster adjuster) Overrides default java.time.temporal.Temporal.with. Returns an adjusted copy of this year. This returns a `Year`, based on this one, with the year adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made. The result of this method is obtained by invoking the `TemporalAdjuster#adjustInto(Temporal)` method on the specified adjuster passing `this` as the argument. This instance is immutable and unaffected by this method call. Parameters adjuster:TemporalAdjuster the adjuster to use, not null Returns:Year a `Year` based on `this` with the adjustment made, not null Annotations @Override Exceptions DateTimeException: if the adjustment cannot be made ArithmeticException: if numeric overflow occurs

public Year with(TemporalAdjuster adjuster)

Overrides default java.time.temporal.Temporal.with.

Returns an adjusted copy of this year.

This returns a Year, based on this one, with the year adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.

The result of this method is obtained by invoking the TemporalAdjuster#adjustInto(Temporal) method on the specified adjuster passing this as the argument.

This instance is immutable and unaffected by this method call.

Parameters

adjuster:TemporalAdjuster: the adjuster to use, not null

Returns:Year

a Year based on this with the adjustment made, not null

Annotations

@Override

Exceptions

DateTimeException:: if the adjustment cannot be made
ArithmeticException:: if numeric overflow occurs

with back to summary

with	back to summary
public Year with(TemporalField field, long newValue) Implements java.time.temporal.Temporal.with. 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. Parameters field:TemporalField the field to set in the result, not null newValue:long the new value of the field in the result Returns:Year a `Year` based on `this` with the specified field set, not null Annotations @Override Exceptions DateTimeException: if the field cannot be set UnsupportedTemporalTypeException: if the field is not supported ArithmeticException: if numeric overflow occurs

public Year with(TemporalField field, long newValue)

Implements java.time.temporal.Temporal.with.

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.

Parameters

field:TemporalField: the field to set in the result, not null
newValue:long: the new value of the field in the result

Returns:Year

a Year based on this with the specified field set, not null

Annotations

@Override

Exceptions

DateTimeException:: if the field cannot be set
UnsupportedTemporalTypeException:: if the field is not supported
ArithmeticException:: if numeric overflow occurs

writeExternal	back to summary
pack-priv void writeExternal(DataOutput out) throws IOException

writeReplace back to summary

private Object writeReplace()

Writes the object using a dedicated serialized form.

Returns:Object

the instance of Ser, not null

Annotations

@Serial

Serial data

 out.writeByte(11);  // identifies a Year
 out.writeInt(year);

public final Class Year

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail