Class YearMonth

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

See java.time.YearMonth for full documentation

Hierarchy

YearMonth

Constructors

constructor

new YearMonth(): YearMonth
Returns YearMonth

Methods

adjustInto

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

atDay

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

atEndOfMonth

atEndOfMonth(): LocalDate
Returns a LocalDate at the end of the month.

Returns LocalDate
- Defined in Java.d.ts:3829

compareTo

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

format

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

get

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

getLong

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

getMonth

getMonth(): Month
Gets the month-of-year field using the Month enum.

Returns Month
- Defined in Java.d.ts:3849

getMonthValue

getMonthValue(): number
Gets the month-of-year field from 1 to 12.

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

getYear

getYear(): number
Gets the year field.

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

isAfter

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

isBefore

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

isLeapYear

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

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

isSupported

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

isValidDay

isValidDay(dayOfMonth): boolean
Checks if the day-of-month is valid for this year-month.
Parameters
- dayOfMonth: number
Returns boolean
- Defined in Java.d.ts:3881

lengthOfMonth

lengthOfMonth(): number
Returns the length of the month, taking account of the year.

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

lengthOfYear

lengthOfYear(): number
Returns the length of the year.

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

minus

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

minusMonths

minusMonths(monthsToSubtract): YearMonth
Returns a copy of this YearMonth with the specified number of months subtracted.
Parameters
- monthsToSubtract: number
Returns YearMonth
- Defined in Java.d.ts:3901

minusYears

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

plus

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

plusMonths

plusMonths(monthsToAdd): YearMonth
Returns a copy of this YearMonth with the specified number of months added.
Parameters
- monthsToAdd: number
Returns YearMonth
- Defined in Java.d.ts:3917

plusYears

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

query

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

range

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

until

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

with

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

withMonth

withMonth(month): YearMonth
Returns a copy of this YearMonth with the month-of-year altered.
Parameters
- month: number
Returns YearMonth
- Defined in Java.d.ts:3945

withYear

withYear(year): YearMonth
Returns a copy of this YearMonth with the year altered.
Parameters
- year: number
Returns YearMonth
- Defined in Java.d.ts:3949

`Static` from

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

`Static` now

now(clockOrZoneId?): YearMonth
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 YearMonth
- Defined in Java.d.ts:3805

`Static` of

of(year, month): YearMonth
Obtains an instance of YearMonth from a year and month.
Parameters
- year: number
- month: number
Returns YearMonth
- Defined in Java.d.ts:3809
of(year, month): YearMonth
Obtains an instance of YearMonth from a year and month.
Parameters
- year: number
- month: Month
Returns YearMonth
- Defined in Java.d.ts:3813

`Static` parse

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

Generated using TypeDoc