Class Year

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

See java.time.Year for full documentation

Hierarchy

Year

Index

Constructors

constructor

new Year(): Year
Returns Year

Methods

adjustInto

adjustInto(temporal): Temporal
Adjusts the specified temporal object to have this year.
Parameters
- temporal: Temporal
Returns Temporal
- Defined in Java.d.ts:3676

atDay

atDay(dayOfYear): LocalDate
Combines this year with a day-of-year to create a LocalDate.
Parameters
- dayOfYear: number
Returns LocalDate
- Defined in Java.d.ts:3680

atMonth

atMonth(month): YearMonth
Combines this year with a month to create a YearMonth.
Parameters
- month: number
Returns YearMonth
- Defined in Java.d.ts:3684
atMonth(month): YearMonth
Combines this year with a month to create a YearMonth.
Parameters
- month: Month
Returns YearMonth
- Defined in Java.d.ts:3688

atMonthDay

atMonthDay(monthDay): LocalDate
Combines this year with a month-day to create a LocalDate.
Parameters
- monthDay: MonthDay
Returns LocalDate
- Defined in Java.d.ts:3692

compareTo

compareTo(other): number
Compares this year to another year.
Parameters
- other: Year
Returns number
- Defined in Java.d.ts:3696

equals

equals(obj): boolean
Checks if this year is equal to another year.
Parameters
- obj: Object
Returns boolean
- Defined in Java.d.ts:3700

format

format(formatter): string
Formats this year using the specified formatter.
Parameters
- formatter: DateTimeFormatter
Returns string
- Defined in Java.d.ts:3704

get

get(field): number
Gets the value of the specified field from this year as an int.
Parameters
- field: TemporalField
Returns number
- Defined in Java.d.ts:3708

getLong

getLong(field): number
Gets the value of the specified field from this year as a long.
Parameters
- field: TemporalField
Returns number
- Defined in Java.d.ts:3712

getValue

getValue(): number
Gets the year value.

Returns number
- Defined in Java.d.ts:3716

isAfter

isAfter(other): boolean
Checks if this year is after the specified year.
Parameters
- other: Year
Returns boolean
- Defined in Java.d.ts:3720

isBefore

isBefore(other): boolean
Checks if this year is before the specified year.
Parameters
- other: Year
Returns boolean
- Defined in Java.d.ts:3724

isLeap

isLeap(): boolean
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.

Returns boolean
- Defined in Java.d.ts:3728

isSupported

isSupported(field): boolean
Checks if the specified field is supported.
Parameters
- field: TemporalField
Returns boolean
- Defined in Java.d.ts:3732
isSupported(unit): boolean
Checks if the specified unit is supported.
Parameters
- unit: TemporalUnit
Returns boolean
- Defined in Java.d.ts:3736

isValidMonthDay

isValidMonthDay(monthDay): boolean
Checks if the month-day is valid for this year.
Parameters
- monthDay: MonthDay
Returns boolean
- Defined in Java.d.ts:3740

length

length(): number
Gets the length of this year in days.

Returns number
- Defined in Java.d.ts:3744

minus

minus(amountToSubtract, unit): Year
Returns a copy of this year with the specified amount subtracted.
Parameters
- amountToSubtract: number
- unit: TemporalUnit
Returns Year
- Defined in Java.d.ts:3748
minus(amountToSubtract): Year
Returns a copy of this year with the specified amount subtracted.
Parameters
- amountToSubtract: TemporalAmount
Returns Year
- Defined in Java.d.ts:3752

minusYears

minusYears(yearsToSubtract): Year
Returns a copy of this Year with the specified number of years subtracted.
Parameters
- yearsToSubtract: number
Returns Year
- Defined in Java.d.ts:3756

plus

plus(amountToAdd, unit): Year
Returns a copy of this year with the specified amount added.
Parameters
- amountToAdd: number
- unit: TemporalUnit
Returns Year
- Defined in Java.d.ts:3760
plus(amountToAdd): Year
Returns a copy of this year with the specified amount added.
Parameters
- amountToAdd: TemporalAmount
Returns Year
- Defined in Java.d.ts:3764

plusYears

plusYears(yearsToAdd): Year
Returns a copy of this Year with the specified number of years added.
Parameters
- yearsToAdd: number
Returns Year
- Defined in Java.d.ts:3768

query

query<R>(query): R
Queries this year using the specified query.
Type Parameters
- R
Parameters
- query: TemporalQueryFn<R>
Returns R
- Defined in Java.d.ts:3772

range

range(field): ValueRange
Gets the range of valid values for the specified field.
Parameters
- field: TemporalField
Returns ValueRange
- Defined in Java.d.ts:3776

until

until(endExclusive, unit): number
Calculates the amount of time until another year in terms of the specified unit.
Parameters
- endExclusive: Temporal
- unit: TemporalUnit
Returns number
- Defined in Java.d.ts:3780

with

with(adjuster): Year
Returns an adjusted copy of this year.
Parameters
- adjuster: TemporalAdjusterFn
Returns Year
- Defined in Java.d.ts:3784
with(field, newValue): Year
Returns a copy of this year with the specified field set to a new value.
Parameters
- field: TemporalField
- newValue: number
Returns Year
- Defined in Java.d.ts:3788

`Static` from

from(temporal): Year
Obtains an instance of Year from a temporal object.
Parameters
- temporal: TemporalAccessor
Returns Year
- Defined in Java.d.ts:3655

`Static` isLeap

isLeap(year): boolean
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.
Parameters
- year: number
Returns boolean
- Defined in Java.d.ts:3659

`Static` now

now(clockOrZoneId?): Year
Obtains the current date-time from the system clock in the default time-zone.
Parameters
- Optional clockOrZoneId: Clock | ZoneId
  Obtains the current date-time from the specified clock or the system clock in the specified time-zone.
Returns Year
- Defined in Java.d.ts:3664

`Static` of

of(isoYear): Year
Obtains an instance of Year.
Parameters
- isoYear: number
Returns Year
- Defined in Java.d.ts:3668

`Static` parse

parse(text, formatter?): Year
Obtains an instance of Year from a text string such as 2007.
Parameters
- text: string
- Optional formatter: DateTimeFormatter
Returns Year
- Defined in Java.d.ts:3672

Generated using TypeDoc