core / io.islandtime.parser

Package io.islandtime.parser

A set of predefined parsers that can be used to convert strings in various ISO formats into date-time primitives, along with a parsing engine that provides the ability to define custom parsers.

Types

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

DateTimeParseException

class DateTimeParseException : DateTimeException
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

DateTimeParser

A parser that converts text into a collection of date-time fields that are understood throughout Island Time.

abstract class DateTimeParser
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

DateTimeParserBuilder

interface DateTimeParserBuilder
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

DateTimeParseResult

The result of a parsing operation.

data class DateTimeParseResult
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

DateTimeParsers

A set of predefined parsers.

object DateTimeParsers
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

DateTimeParserSettings

Settings that control the parsing behavior.

data class DateTimeParserSettings
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

DecimalNumberParserBuilder

interface DecimalNumberParserBuilder : NumberParserBuilder
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

GroupedDateTimeParser

class GroupedDateTimeParser
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

GroupedDateTimeParserBuilder

interface GroupedDateTimeParserBuilder
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

LiteralParserBuilder

interface LiteralParserBuilder
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

NumberParserBuilder

interface NumberParserBuilder
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

SignParserBuilder

interface SignParserBuilder
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

SignStyle

enum class SignStyle
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

StringParseAction

enum class StringParseAction
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

StringParserBuilder

interface StringParserBuilder
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

WholeNumberParserBuilder

interface WholeNumberParserBuilder : NumberParserBuilder

Annotations

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

DateTimeParserDsl

annotation class DateTimeParserDsl

Functions

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

amPm

Parse the AM or PM of the day from its textual representation.

fun DateTimeParserBuilder.amPm(): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

dateTimeParser

Define a custom DateTimeParser.

fun dateTimeParser(builder: DateTimeParserBuilder.() -> Unit): DateTimeParser
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

dayOfMonth

Parse a day of the month value with a variable number of digits.

fun DateTimeParserBuilder.dayOfMonth(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse a day of the month value with a fixed number of digits.

fun DateTimeParserBuilder.dayOfMonth(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

dayOfWeekNumber

Parse a day of week number with a fixed number of digits.

fun DateTimeParserBuilder.dayOfWeekNumber(length: Int = 1, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

dayOfYear

Parse a day of the year value with a variable number of digits.

fun DateTimeParserBuilder.dayOfYear(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse a day of the year value with a fixed number of digits.

fun DateTimeParserBuilder.dayOfYear(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

durationOfFractionalSeconds

Parse a duration of fractional seconds.

fun DateTimeParserBuilder.durationOfFractionalSeconds(wholeLength: IntRange = 1..19, fractionLength: IntRange = 0..9, fractionScale: Int = 9, builder: DecimalNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

durationOfHours

Parse a duration of whole hours.

fun DateTimeParserBuilder.durationOfHours(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

durationOfMinutes

Parse a duration of whole minutes.

fun DateTimeParserBuilder.durationOfMinutes(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

durationOfSeconds

Parse a duration of whole seconds.

fun DateTimeParserBuilder.durationOfSeconds(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

era

Parse an era from its textual representation in any of the specified styles.

fun DateTimeParserBuilder.era(styles: Set<TextStyle>): Unit

Parse an era from its textual representation in a specific style.

fun DateTimeParserBuilder.era(style: TextStyle): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

fractionalSecondOfMinute

Parse a fractional second of the minute.

fun DateTimeParserBuilder.fractionalSecondOfMinute(wholeLength: IntRange = 1..2, fractionLength: IntRange = 0..9, fractionScale: Int = 9, builder: DecimalNumberParserBuilder.() -> Unit = {}): Unit

Parse a fractional second of the minute with a fixed number of characters representing the whole second.

fun DateTimeParserBuilder.fractionalSecondOfMinute(wholeLength: Int, fractionLength: IntRange = 0..9, fractionScale: Int = 9, builder: DecimalNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

groupedDateTimeParser

Create a GroupedDateTimeParser.

fun groupedDateTimeParser(builder: GroupedDateTimeParserBuilder.() -> Unit): GroupedDateTimeParser
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

hourOfDay

Parse an hour of the day with a variable number of digits.

fun DateTimeParserBuilder.hourOfDay(length: IntRange = 1..2, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse an hour of the day with a fixed number of digits.

fun DateTimeParserBuilder.hourOfDay(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

localizedDayOfWeek

Parse a day of the week from its textual representation in any of the specified styles.

fun DateTimeParserBuilder.localizedDayOfWeek(styles: Set<TextStyle>): Unit

Parse a day of the week from its textual representation in a specific style.

fun DateTimeParserBuilder.localizedDayOfWeek(style: TextStyle): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

localizedMonth

Parse a month from its textual representation in any of the specified styles.

fun DateTimeParserBuilder.localizedMonth(styles: Set<TextStyle>): Unit

Parse a month from its textual representation in a specific style.

fun DateTimeParserBuilder.localizedMonth(style: TextStyle): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

minuteOfHour

Parse a minute of the hour with a variable number of digits.

fun DateTimeParserBuilder.minuteOfHour(length: IntRange = 1..2, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse a minute of the hour with a fixed number of digits.

fun DateTimeParserBuilder.minuteOfHour(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

monthNumber

Parse a month of year value with a variable number of digits.

fun DateTimeParserBuilder.monthNumber(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse a month of year number with a fixed number of digits.

fun DateTimeParserBuilder.monthNumber(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

periodOfDays

Parse a period of whole days.

fun DateTimeParserBuilder.periodOfDays(length: IntRange = 1..10, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

periodOfMonths

Parse a period of whole months.

fun DateTimeParserBuilder.periodOfMonths(length: IntRange = 1..10, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

periodOfWeeks

Parse a period of whole weeks.

fun DateTimeParserBuilder.periodOfWeeks(length: IntRange = 1..10, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

periodOfYears

Parse a period of whole years.

fun DateTimeParserBuilder.periodOfYears(length: IntRange = 1..10, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

periodSign

Parses a number's sign and populates DateTimeField.PERIOD_SIGN with -1L, if negative or 1L, if positive.

fun DateTimeParserBuilder.periodSign(): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

secondOfMinute

Parse a second of the minute with a variable number of digits.

fun DateTimeParserBuilder.secondOfMinute(length: IntRange = 1..2, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse a second of the minute with a fixed number of digits.

fun DateTimeParserBuilder.secondOfMinute(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

timeZoneId

Parse a time zone region ID.

fun DateTimeParserBuilder.timeZoneId(): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

unboundedDesignator

Parses the string ".." and populates DateTimeField.IS_UNBOUNDED with 1L.

fun DateTimeParserBuilder.unboundedDesignator(): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

utcDesignator

Parses the character 'Z' and populates DateTimeField.UTC_OFFSET_TOTAL_SECONDS with 0L.

fun DateTimeParserBuilder.utcDesignator(): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

utcOffsetHours

fun DateTimeParserBuilder.utcOffsetHours(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

utcOffsetMinutes

fun DateTimeParserBuilder.utcOffsetMinutes(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

utcOffsetSeconds

fun DateTimeParserBuilder.utcOffsetSeconds(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

utcOffsetSign

Parses a number's sign and populates DateTimeField.UTC_OFFSET_SIGN with -1L, if negative or 1L, if positive.

fun DateTimeParserBuilder.utcOffsetSign(): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

year

Parse a year with a variable number of digits.

fun DateTimeParserBuilder.year(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse a year with a fixed number of digits.

fun DateTimeParserBuilder.year(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

yearOfEra

Parse a year of era with a variable number of digits.

fun DateTimeParserBuilder.yearOfEra(length: IntRange = 1..19, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit

Parse a year of era with a fixed number of digits.

fun DateTimeParserBuilder.yearOfEra(length: Int, builder: WholeNumberParserBuilder.() -> Unit = {}): Unit