core/org.jetbrains.kotlinx.dataframe.api/convertToLocalTime

convertToLocalTime

@JvmName(name = "convertToLocalTimeFromT")

fun <T : Any> DataColumn<T>.convertToLocalTime(): DataColumn<LocalTime>

Converts values in this column to LocalTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime values.

fun <T : Any> DataColumn<T?>.convertToLocalTime(): DataColumn<LocalTime?>

Converts values in this column to LocalTime. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime nullable values.

@JvmName(name = "convertToLocalTimeFromLong")

fun DataColumn<Long>.convertToLocalTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalTime>

Converts values in this Long column to LocalTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime values.

Parameters

zone

The TimeZone used to interpret the Long timestamp as a time. Defaults to the system current time zone.

fun DataColumn<Long?>.convertToLocalTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalTime?>

Converts values in this Long column to LocalTime. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime nullable values.

Parameters

zone

The TimeZone used to interpret the Long timestamp as a time. Defaults to the system current time zone.

@JvmName(name = "convertToLocalTimeFromInt")

fun DataColumn<Int>.convertToLocalTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalTime>

Converts values in this Int column to LocalTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime values.

Parameters

zone

The TimeZone used to interpret the Int timestamp as a time. Defaults to the system current time zone.

@JvmName(name = "convertToLocalTimeIntNullable")

fun DataColumn<Int?>.convertToLocalTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalTime?>

Converts values in this Int column to LocalTime. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime nullable values.

Parameters

zone

The TimeZone used to interpret the Int timestamp as a time. Defaults to the system current time zone.

@JvmName(name = "convertToLocalTimeFromString")

fun DataColumn<String>.convertToLocalTime(format: DateTimeFormat<LocalTime>? = null): DataColumn<LocalTime>

Converts values in this String column to LocalTime.

Trims each string and attempts to parse it using the specified format. Fails with an exception if a value cannot be parsed.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime values.

Parameters

format

An optional DateTimeFormat to use when parsing. If null, the defaults will be used.

@JvmName(name = "convertToLocalTimeFromStringPattern")

@FormatStringsInDatetimeFormats

fun DataColumn<String>.convertToLocalTime(pattern: String): DataColumn<LocalTime>

Converts values in this String column to LocalTime.

Trims each string and attempts to parse it using the specified pattern. Fails with an exception if a value cannot be parsed.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime values.

Parameters

pattern

An optional date pattern to use for parsing.

@JvmName(name = "convertToLocalTimeFromStringNullable")

fun DataColumn<String?>.convertToLocalTime(format: DateTimeFormat<LocalTime>? = null): DataColumn<LocalTime?>

Converts values in this String column to LocalTime. Preserves null values.

Trims each string and attempts to parse it using the specified format. Fails with an exception if a value cannot be parsed.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime nullable values.

Parameters

format

An optional DateTimeFormat to use when parsing. If null, the defaults will be used.

@JvmName(name = "convertToLocalTimeFromStringNullablePattern")

@FormatStringsInDatetimeFormats

fun DataColumn<String?>.convertToLocalTime(pattern: String): DataColumn<LocalTime?>

Converts values in this String column to LocalTime. Preserves null values.

Trims each string and attempts to parse it using the specified pattern. Fails with an exception if a value cannot be parsed.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime nullable values.

Parameters

pattern

An optional date pattern to use for parsing.

@JvmName(name = "convertToLocalTimeFromDateTimeComponents")

fun DataColumn<DateTimeComponents>.convertToLocalTime(): DataColumn<LocalTime>

Converts values in this DateTimeComponents column to LocalTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime values.

@JvmName(name = "convertToLocalTimeFromDateTimeComponentsNullable")

fun DataColumn<DateTimeComponents?>.convertToLocalTime(): DataColumn<LocalTime?>

Converts values in this DateTimeComponents column to LocalTime. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalTime nullable values.

@JvmName(name = "convertToLocalTimeFromString")

fun DataColumn<String>.~~convertToLocalTime~~(pattern: String? = null, locale: Locale? = null): DataColumn<LocalTime>

@JvmName(name = "convertToLocalTimeFromStringNullable")

fun DataColumn<String?>.~~convertToLocalTime~~(pattern: String? = null, locale: Locale? = null): DataColumn<LocalTime?>

Deprecated (with error)

We no longer accept `Locale` in String -> Kotlin date-time conversion functions, as we now directly parse to Kotlin. If you need to specify a locale to make it work, convert to Java-based types first. Will be ERROR in 1.0.

Replace with

this.convertToJavaLocalTime(pattern, locale).convertToLocalTime()