core / io.islandtime / kotlin.String / toYear

toYear

(iosArm64) fun String.toYear(): Year
(iosX64) fun String.toYear(): Year
(jvm) fun String.toYear(): Year
(macosX64) fun String.toYear(): Year
(tvosArm64) fun String.toYear(): Year
(tvosX64) fun String.toYear(): Year
(watchosArm64) fun String.toYear(): Year
(watchosX86) fun String.toYear(): Year

Converts a string to a Year.

The string is assumed to be an ISO-8601 year. For example, 2010, +002010, or 'Y12345'. The output of Year.toString can be safely parsed using this method.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed year is invalid

(iosArm64) fun String.toYear(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): Year
(iosX64) fun String.toYear(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): Year
(jvm) fun String.toYear(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): Year
(macosX64) fun String.toYear(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): Year
(tvosArm64) fun String.toYear(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): Year
(tvosX64) fun String.toYear(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): Year
(watchosArm64) fun String.toYear(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): Year
(watchosX86) fun String.toYear(parser: DateTimeParser, settings: DateTimeParserSettings = DateTimeParserSettings.DEFAULT): Year

Converts a string to a Year using a specific parser.

A set of predefined parsers can be found in DateTimeParsers.

The parser must be capable of supplying DateTimeField.YEAR.

Exceptions

DateTimeParseException - if parsing fails

DateTimeException - if the parsed year is invalid