Year

Companion object Year

final class Year extends TemporalAccessor with Temporal with TemporalAdjuster with Ordered[Year] with Serializable

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.

Specification for implementors

This class is immutable and thread-safe.

Annotations: @SerialVersionUID()

Linear Supertypes

Serializable, Ordered[Year], Comparable[Year], TemporalAdjuster, Temporal, TemporalAccessor, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Year
Serializable
Ordered
Comparable
TemporalAdjuster
Temporal
TemporalAccessor
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
def <(that: Year): Boolean
Definition Classes
Ordered
def <=(that: Year): Boolean
Definition Classes
Ordered
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def >(that: Year): Boolean
Definition Classes
Ordered
def >=(that: Year): Boolean
Definition Classes
Ordered
def adjustInto(temporal: Temporal): Temporal
Adjusts the specified temporal object to have this year.
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 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
returns
the adjusted object, not null
Definition Classes
Year → TemporalAdjuster
Exceptions thrown
ArithmeticException if numeric overflow occurs
DateTimeException if unable to make the adjustment
final def asInstanceOf[T0]: T0
Definition Classes
Any
def atDay(dayOfYear: Int): LocalDate
Combines this year with a day-of-year to create a LocalDate.
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.
dayOfYear
the day-of-year to use, not null
returns
the local date formed from this year and the specified date of year, not null
Exceptions thrown
DateTimeException if the day of year is zero or less, 366 or greater or equal to 366 and this is not a leap year
def atMonth(month: Int): YearMonth
Combines this year with a month to create a YearMonth.
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, from 1 (January) to 12 (December)
returns
the year-month formed from this year and the specified month, not null
Exceptions thrown
DateTimeException if the month is invalid
def atMonth(month: Month): YearMonth
Combines this year with a month to create a YearMonth.
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
returns
the year-month formed from this year and the specified month, not null
def atMonthDay(monthDay: MonthDay): LocalDate
Combines this year with a month-day to create a LocalDate.
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.
monthDay
the month-day to use, not null
returns
the local date formed from this year and the specified month-day, not null
def clone(): AnyRef
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def compare(other: Year): Int
Compares this year to another year.
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
returns
the comparator value, negative if less, positive if greater
Definition Classes
Year → Ordered
def compareTo(other: Year): Int
Definition Classes
Year → Ordered → Comparable
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(obj: Any): Boolean
Checks if this year is equal to another year.
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
returns
true if this is equal to the other year
Definition Classes
Year → AnyRef → Any
def finalize(): Unit
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
def format(formatter: DateTimeFormatter): String
Outputs this year as a String using the formatter.
Outputs this year as a String using the formatter.
This year will be passed to the formatter print method.
formatter
the formatter to use, not null
returns
the formatted year string, not null
Exceptions thrown
DateTimeException if an error occurs during printing
def get(field: TemporalField): Int
Gets the value of the specified field from this year as an int.
Gets the value of the specified field from this year as an int.
This queries this year for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is 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 a DateTimeException.
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
returns
the value for the field
Definition Classes
Year → TemporalAccessor
Exceptions thrown
ArithmeticException if numeric overflow occurs
DateTimeException if a value for the field cannot be obtained
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def getLong(field: TemporalField): Long
Gets the value of the specified field from this year as a long.
Gets the value of the specified field from this year as a long.
This queries this year for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is 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 a DateTimeException.
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
returns
the value for the field
Definition Classes
Year → TemporalAccessor
Exceptions thrown
ArithmeticException if numeric overflow occurs
DateTimeException if a value for the field cannot be obtained
def getValue: Int
Gets the year value.
Gets the year value.
The year returned by this method is proleptic as per get(YEAR).
returns
the year, { @code MIN_VALUE} to { @code MAX_VALUE}
def hashCode(): Int
A hash code for this year.
A hash code for this year.
returns
a suitable hash code
Definition Classes
Year → AnyRef → Any
def isAfter(other: Year): Boolean
Is this year after the specified year.
Is this year after the specified year.
other
the other year to compare to, not null
returns
true if this is after the specified year
def isBefore(other: Year): Boolean
Is this year before the specified year.
Is this year before the specified year.
other
the other year to compare to, not null
returns
true if this point is before the specified year
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def isLeap: Boolean
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.
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
def isSupported(unit: TemporalUnit): Boolean
Checks if the specified unit is supported.
Checks if the specified unit is supported.
This checks if the date-time can be queried for the specified unit. If false, then calling the plus and minus methods will throw an exception.
Specification for implementors
Implementations must check and handle all fields defined in ChronoUnit. If the field is supported, then true is returned, otherwise false
If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument.
Implementations must not alter this object.
unit
the unit to check, null returns false
returns
true if this date-time can be queried for the unit, false if not
Definition Classes
Year → Temporal
def isSupported(field: TemporalField): Boolean
Checks if the specified field is supported.
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 and get methods will throw an exception.
If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date-time. 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
returns
true if the field is supported on this year, false if not
Definition Classes
Year → TemporalAccessor
def isValidMonthDay(monthDay: MonthDay): Boolean
Checks if the month-day is valid for this year.
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.
monthDay
the month-day to validate, null returns false
returns
true if the month and day are valid for this year
def length: Int
Gets the length of this year in days.
Gets the length of this year in days.
returns
the length of this year in days, 365 or 366
def minus(amountToSubtract: Long, unit: TemporalUnit): Year
Returns an object of the same type as this object with the specified period subtracted.
Returns an object of the same type as this object with the specified period subtracted.
This method returns a new object based on this one with the specified period subtracted. For example, on a LocalDate, this could be used to subtract a number of years, months or days. The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
If the implementation represents a date-time that has boundaries, such as LocalTime, then the permitted units must include the boundary unit, but no multiples of the boundary unit. For example, LocalTime must accept DAYS but not WEEKS or MONTHS.
Specification for implementors
Implementations must behave in a manor equivalent to the default method behavior.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
amountToSubtract
the amount of the specified unit to subtract, may be negative
unit
the unit of the period to subtract, not null
returns
an object of the same type with the specified period subtracted, not null
Definition Classes
Year → Temporal
Exceptions thrown
ArithmeticException { @inheritDoc}
DateTimeException { @inheritDoc}
def minus(amount: TemporalAmount): Year
Returns a copy of this year with the specified period subtracted.
Returns a copy of this year with the specified period subtracted.
This method returns a new year based on this year with the specified period subtracted. The subtractor is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to TemporalUnit).
This instance is immutable and unaffected by this method call.
amount
the amount to subtract, not null
returns
a { @code Year} based on this year with the subtraction made, not null
Definition Classes
Year → Temporal
Exceptions thrown
ArithmeticException if numeric overflow occurs
DateTimeException if the subtraction cannot be made
def minusYears(yearsToSubtract: Long): Year
Returns a copy of this year with the specified number of years subtracted.
Returns a copy of this year with the specified number of years subtracted.
This instance is immutable and unaffected by this method call.
yearsToSubtract
the years to subtract, may be negative
returns
a { @code Year} based on this year with the period subtracted, not null
Exceptions thrown
DateTimeException if the result exceeds the supported year range
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def plus(amountToAdd: Long, unit: TemporalUnit): Year
Returns an object of the same type as this object with the specified period added.
Returns an object of the same type as this object with the specified period added.
This method returns a new object based on this one with the specified period added. For example, on a LocalDate, this could be used to add a number of years, months or days. The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
If the implementation represents a date-time that has boundaries, such as LocalTime, then the permitted units must include the boundary unit, but no multiples of the boundary unit. For example, LocalTime must accept DAYS but not WEEKS or MONTHS.
Specification for implementors
Implementations must check and handle all units defined in ChronoUnit. If the unit is supported, then the addition must be performed. If unsupported, then a DateTimeException must be thrown.
If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long) passing this as the first argument.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
amountToAdd
the amount of the specified unit to add, may be negative
unit
the unit of the period to add, not null
returns
an object of the same type with the specified period added, not null
Definition Classes
Year → Temporal
Exceptions thrown
ArithmeticException { @inheritDoc}
DateTimeException { @inheritDoc}
def plus(amount: TemporalAmount): Year
Returns a copy of this year with the specified period added.
Returns a copy of this year with the specified period added.
This method returns a new year based on this year with the specified period added. The adder is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to TemporalUnit).
This instance is immutable and unaffected by this method call.
amount
the amount to add, not null
returns
a { @code Year} based on this year with the addition made, not null
Definition Classes
Year → Temporal
Exceptions thrown
ArithmeticException if numeric overflow occurs
DateTimeException if the addition cannot be made
def plusYears(yearsToAdd: Long): Year
Returns a copy of this year with the specified number of years added.
Returns a copy of this year with the specified number of years added.
This instance is immutable and unaffected by this method call.
yearsToAdd
the years to add, may be negative
returns
a { @code Year} based on this year with the period added, not null
Exceptions thrown
DateTimeException if the result exceeds the supported year range
def query[R](query: TemporalQuery[R]): R
Queries this year using the specified 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.
R
the type of the result
query
the query to invoke, not null
returns
the query result, null may be returned (defined by the query)
Definition Classes
Year → TemporalAccessor
Exceptions thrown
ArithmeticException if numeric overflow occurs (defined by the query)
DateTimeException if unable to query (defined by the query)
def range(field: TemporalField): ValueRange
Gets the range of valid values for the specified 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 a DateTimeException.
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
returns
the range of valid values for the field, not null
Definition Classes
Year → TemporalAccessor
Exceptions thrown
DateTimeException if the range for the field cannot be obtained
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Outputs this year as a String.
Outputs this year as a String.
returns
a string representation of this year, not null
Definition Classes
Year → AnyRef → Any
def until(endExclusive: Temporal, unit: TemporalUnit): Long
Calculates the period between this year and another year in terms of the specified unit.
Calculates the period between this year and another year in terms of the specified unit.
This calculates the period between two years in terms of a single unit. 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 must be a Year. For example, the period 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 period in decades between 2012 and 2031 will only be one decade as it is one year short of two decades.
This method operates in association with TemporalUnit#between. The result of this method is a long representing the amount of the specified unit. By contrast, the result of between is an object that can be used directly in addition/subtraction:
```
long period = start.until(end, YEARS);   // this method
dateTime.plus(YEARS.between(start, end));      // use in plus/minus
```
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 input temporal as the second argument.
This instance is immutable and unaffected by this method call.
endExclusive
the end year, which is converted to a { @code Year}, not null
unit
the unit to measure the period in, not null
returns
the amount of the period between this year and the end year
Definition Classes
Year → Temporal
Exceptions thrown
ArithmeticException if numeric overflow occurs
DateTimeException if the period cannot be calculated
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
def with(field: TemporalField, newValue: Long): Year
Returns a copy of this year with the specified field set to a new value.
Returns a copy of this year with the specified field set to a new value.
This returns a new 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 a DateTimeException.
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
newValue
the new value of the field in the result
returns
a { @code Year} based on { @code this} with the specified field set, not null
Definition Classes
Year → Temporal
Exceptions thrown
ArithmeticException if numeric overflow occurs
DateTimeException if the field cannot be set
def with(adjuster: TemporalAdjuster): Year
Returns an adjusted copy of this year.
Returns an adjusted copy of this year.
This returns a new 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.
adjuster
the adjuster to use, not null
returns
a { @code Year} based on { @code this} with the adjustment made, not null
Definition Classes
Year → Temporal
Exceptions thrown
ArithmeticException if numeric overflow occurs
DateTimeException if the adjustment cannot be made

Packages

Dates and Times

Duration and Period

Additional value types

Example

Fields and Units

Adjustment

Weeks

Year

Companion object Year

final class Year extends TemporalAccessor with Temporal with TemporalAdjuster with Ordered[Year] with Serializable

Specification for implementors

Value Members

Specification for implementors

Specification for implementors

Specification for implementors

Inherited from Serializable

Inherited from Ordered[Year]

Inherited from Comparable[Year]

Inherited from TemporalAdjuster

Inherited from Temporal

Inherited from TemporalAccessor

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Dates and Times

Duration and Period

Additional value types

Example

Fields and Units

Adjustment

Weeks

Year

Companion object Year

final class Year extends TemporalAccessor with Temporal with TemporalAdjuster with Ordered[Year] with Serializable

Specification for implementors

Value Members

Specification for implementors

Specification for implementors

Specification for implementors

Inherited from Serializable

Inherited from Ordered[Year]

Inherited from Comparable[Year]

Inherited from TemporalAdjuster

Inherited from Temporal

Inherited from TemporalAccessor

Inherited from AnyRef

Inherited from Any

Ungrouped

Year