//core/io.islandtime/Month/JANUARY
JANUARY¶
common
Properties¶
Name | Summary |
---|---|
firstDayOfYearInCommonYear | common val firstDayOfYearInCommonYear: Int The day of the year corresponding to the month's first day in a common year. |
firstDayOfYearInLeapYear | common val firstDayOfYearInLeapYear: Int The day of the year corresponding to the month's first day in a leap year. |
lastDayInCommonYear | common val lastDayInCommonYear: Int The last day of the month in a common year. |
lastDayInLeapYear | common val lastDayInLeapYear: Int The last day of the month in a leap year. |
lengthInCommonYear | common val lengthInCommonYear: Days The number of days in the month in a common year. |
lengthInLeapYear | common val lengthInLeapYear: Days The number of days in the month in a leap year. |
name | common val name: String |
number | common val number: Int The ISO month number, from 1-12. |
ordinal | common val ordinal: Int |
Functions¶
Name | Summary |
---|---|
dayRangeIn | common fun dayRangeIn(year: Int): IntRange Returns the range of valid days for this month within a given year |
displayName | common fun displayName(style: TextStyle, locale: Locale): String A textual representation of the month, suitable for display purposes. The localized name will be returned, if available. If not, the ISO month number (1-12) will be returned instead. |
firstDayOfYearIn | common fun firstDayOfYearIn(year: Int): Int Returns the day of the year that this month's first days falls on. This may vary depending on whether the year is a leap year. For example, the first day of MARCH will be either 60th or 61st day of the year. |
lastDayIn | common fun lastDayIn(year: Int): Int Returns the last day of the month in year. |
lastDayOfYearIn | common fun lastDayOfYearIn(year: Int): Int Returns the day of the year that this month's last day falls on. This may vary depending on whether the year is a leap year. For example, the last of FEBRUARY will be either 59th or 60th day of the year. |
lengthIn | common fun lengthIn(year: Int): Days Returns the number of days in the month in year. |
localizedName | common fun localizedName(style: TextStyle, locale: Locale): String? The localized name of the month, if available for the locale in the specified style. The result depends on the configured DateTimeTextProvider and may differ between platforms. |
minus | common operator fun minus(months: Months): Month Returns this month with months subtracted from it, wrapping when the beginning or end of the year is reached. |
plus | common operator fun plus(months: Months): Month Returns this month with months added to it, wrapping when the beginning or end of the year is reached. |