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

convertToLocalDateTime

@JvmName(name = "convertToLocalDateTimeFromT")

fun <T : Any> DataColumn<T>.convertToLocalDateTime(): DataColumn<LocalDateTime>

Converts values in this column to LocalDateTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime values.

fun <T : Any> DataColumn<T?>.convertToLocalDateTime(): DataColumn<LocalDateTime?>

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

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime nullable values.

@JvmName(name = "convertToLocalDateTimeFromLong")

fun DataColumn<Long>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime>

Converts values in this Long column to LocalDateTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDate values.

Parameters

zone

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

fun DataColumn<Long?>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime?>

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

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime nullable values.

Parameters

zone

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

@JvmName(name = "convertToLocalDateTimeFromDeprecatedInstant")

fun DataColumn<Instant>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime>

Converts values in this kotlinx.datetime.Instant column to LocalDateTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime values.

Parameters

zone

The TimeZone used to interpret the kotlinx.datetime.Instant timestamp as a date-time. Defaults to the system current time zone.

@JvmName(name = "convertToLocalDateTimeFromDeprecatedInstantNullable")

fun DataColumn<Instant?>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime?>

Converts values in this kotlinx.datetime.Instant column to LocalDateTime. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime nullable values.

Parameters

zone

The TimeZone used to interpret the kotlinx.datetime.Instant timestamp as a date-time. Defaults to the system current time zone.

@JvmName(name = "convertToLocalDateTimeFromStdlibInstant")

fun DataColumn<Instant>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime>

Converts values in this kotlin.time.Instant column to LocalDateTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime values.

Parameters

zone

The TimeZone used to interpret the kotlin.time.Instant timestamp as a date-time. Defaults to the system current time zone.

@JvmName(name = "convertToLocalDateTimeFromStdlibInstantNullable")

fun DataColumn<Instant?>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime?>

Converts values in this kotlin.time.Instant column to LocalDateTime. Preserves null values.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime nullable values.

Parameters

zone

The TimeZone used to interpret the kotlin.time.Instant timestamp as a date-time. Defaults to the system current time zone.

@JvmName(name = "convertToLocalDateTimeFromInt")

fun DataColumn<Int>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime>

Converts values in this Int column to LocalDateTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime values.

Parameters

zone

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

@JvmName(name = "convertToLocalDateTimeFromIntNullable")

fun DataColumn<Int?>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime?>

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

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime nullable values.

Parameters

zone

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

@JvmName(name = "convertToLocalDateTimeFromString")

fun DataColumn<String>.convertToLocalDateTime(format: DateTimeFormat<LocalDateTime>? = null): DataColumn<LocalDateTime>

Converts values in this String column to LocalDateTime.

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 LocalDateTime values.

Parameters

format

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

@JvmName(name = "convertToLocalDateTimeFromStringPattern")

@FormatStringsInDatetimeFormats

fun DataColumn<String>.convertToLocalDateTime(pattern: String): DataColumn<LocalDateTime>

Converts values in this String column to LocalDateTime.

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 LocalDateTime values.

Parameters

pattern

An optional date pattern to use for parsing.

@JvmName(name = "convertToLocalDateTimeFromStringNullable")

fun DataColumn<String?>.convertToLocalDateTime(format: DateTimeFormat<LocalDateTime>? = null): DataColumn<LocalDateTime?>

Converts values in this String column to LocalDateTime. 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 LocalDateTime nullable values.

Parameters

format

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

@JvmName(name = "convertToLocalDateTimeFromStringNullablePattern")

@FormatStringsInDatetimeFormats

fun DataColumn<String?>.convertToLocalDateTime(pattern: String): DataColumn<LocalDateTime?>

Converts values in this String column to LocalDateTime. 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 LocalDateTime nullable values.

Parameters

pattern

An optional date pattern to use for parsing.

@JvmName(name = "convertToLocalDateTimeFromDateTimeComponents")

fun DataColumn<DateTimeComponents>.convertToLocalDateTime(): DataColumn<LocalDateTime>

Converts values in this DateTimeComponents column to LocalDateTime.

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime values.

@JvmName(name = "convertToLocalDateTimeFromDateTimeComponentsNullable")

fun DataColumn<DateTimeComponents?>.convertToLocalDateTime(): DataColumn<LocalDateTime?>

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

For more information: See convert on the documentation website.

Return

A new DataColumn with the LocalDateTime nullable values.

@JvmName(name = "convertToLocalDateTimeFromString")

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

@JvmName(name = "convertToLocalDateTimeFromStringNullable")

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

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.convertToJavaLocalDateTime(pattern, locale).convertToLocalDateTime()