base/com.splendo.kaluga.base.utils

Package-level declarations

Types

abstract class BaseLocale

An object representing a specific geographical, political, or cultural region.

abstract class BaseTimeZone

A TimeZone represents a time zone. Accounts for Daylight Savings

external class BigDecimal(a: Any, b: Any)

BufferedAsListChannel

interface BufferedAsListChannel<T : Any> : SendChannel<T> , ReceiveChannel<List<T>>

A Rendezvous Channel that buffers all elements sent to it in a list until the next receive

object ByteUtils

typealias ~~Date~~ = KalugaDate

sealed class Decimal : Comparable<Decimal>

Immutable, arbitrary-precision signed decimal numbers.

DefaultKalugaDate

actual class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

expect class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

actual class DefaultKalugaDate

Default implementation of KalugaDate

actual class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

actual class DefaultKalugaDate : KalugaDate

Default implementation of KalugaDate

EmptyCompletableDeferred

typealias EmptyCompletableDeferred = CompletableDeferred<Unit>

actual typealias FiniteDecimal = BigDecimal

Platform specific representation of a finite immutable, arbitrary-precision signed decimal number

expect class FiniteDecimal : Comparable<FiniteDecimal>

Platform specific representation of a finite immutable, arbitrary-precision signed decimal number

actual data class FiniteDecimal : Comparable<FiniteDecimal>

Platform specific representation of a finite immutable, arbitrary-precision signed decimal number

actual data class FiniteDecimal : Comparable<FiniteDecimal>

Platform specific representation of a finite immutable, arbitrary-precision signed decimal number

actual typealias FiniteDecimal = BigDecimal

Platform specific representation of a finite immutable, arbitrary-precision signed decimal number

abstract class KalugaDate : Comparable<KalugaDate>

Class describing a point in time Dates are localized according to a KalugaLocale and relative to a given KalugaTimeZone

KalugaDateHolder

actual typealias KalugaDateHolder = Date

expect class KalugaDateHolder

Class holding the platform value of the desired Date.

actual typealias KalugaDateHolder = <Error class: unknown class>

actual typealias KalugaDateHolder = Date

actual typealias KalugaDateHolder = Date

actual data class KalugaLocale : BaseLocale

Default implementation of BaseLocale

expect class KalugaLocale : BaseLocale

Default implementation of BaseLocale

actual data class KalugaLocale

Default implementation of BaseLocale

actual data class KalugaLocale : BaseLocale

Default implementation of BaseLocale

actual data class KalugaLocale : BaseLocale

Default implementation of BaseLocale

actual class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

expect class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

actual class KalugaTimeZone

A default implementation of BaseTimeZone.

actual class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

actual class KalugaTimeZone : BaseTimeZone

A default implementation of BaseTimeZone.

typealias ~~Locale~~ = KalugaLocale

data class Rounding(val maximumFractionDigits: Int? = null, val roundingMode: String = ROUNDING_MODE, val maximumSignificantDigits: Int = DECIMAL_128_SIGNIFICANT_DIGITS)

Rounding for BigDecimal

sealed class RoundingMode

Rounding Mode for rounding a Decimal

actual typealias Serializable = java.io.Serializable

expect interface Serializable

Interface that indicates that the implementing object can be serialized using platform specific serialization.

actual interface Serializable

NOT SUPPORTED ON iOS

actual interface Serializable

Not supported on JavaScript

actual typealias Serializable = java.io.Serializable

typealias ~~TimeZone~~ = KalugaTimeZone

TimeZoneNameStyle

enum TimeZoneNameStyle : Enum<TimeZoneNameStyle>

Style for writing the name of a KalugaTimeZone Can be either TimeZoneNameStyle.Short or TimeZoneNameStyle.Long

enum UnitSystem : Enum<UnitSystem>

The unit system used by a country. For more advanced functionality please use Kaluga Scientific

Properties

val KalugaLocale.Companion.enUsPosix: KalugaLocale

Locale for English/US in a POSIX format. Useful shortcut when dealing with fixed locale formats.

val KalugaDate.isLastMonth: Boolean

True if this KalugaDate is last month

val KalugaDate.isLastYear: Boolean

True if this KalugaDate is last year

val KalugaDate.isNextMonth: Boolean

True if this KalugaDate is next month

val KalugaDate.isNextYear: Boolean

True if this KalugaDate is next year

val KalugaDate.isThisMonth: Boolean

True if this KalugaDate is this month

val KalugaDate.isThisYear: Boolean

True if this KalugaDate is this year

val KalugaDate.isToday: Boolean

True if this KalugaDate is today

val KalugaDate.isTomorrow: Boolean

True if this KalugaDate is tomorrow

val KalugaDate.isYesterday: Boolean

True if this KalugaDate is yesterday

val IntRange.nsRange: <Error class: unknown class><<Error class: unknown class>>

val <Error class: unknown class><<Error class: unknown class>>.range: IntRange

uses24HourClock

val KalugaLocale.uses24HourClock: Boolean

Indicates whether this locale use a 24 hour clock cycle.

val KalugaTimeZone.Companion.utc: KalugaTimeZone

Gets the UTC KalugaTimeZone

Functions

inline fun <T> T.applyIf(condition: Boolean, block: T.() -> Unit): T

Applies a given code block if a given condition is met

BufferedAsListChannel

fun <T : Any> BufferedAsListChannel(coroutineContext: CoroutineContext): BufferedAsListChannel<T>

fun <T : Any> BufferedAsListChannel(coroutineContext: CoroutineContext, dispatcher: CloseableCoroutineDispatcher, closeDispatcherOnCompletion: Boolean): BufferedAsListChannel<T>

Creates a BufferedAsListChannel that batches its elements with a given CoroutineContext

byOrdinalOrDefault

inline fun <T : Enum<T>> Enum.Companion.byOrdinalOrDefault(ordinal: Int, defaultValue: T): T

Returns the enum by matching ordinals position, or the given default value if no ordinals match.

fun bytesOf(vararg bytes: Int): ByteArray

Returns ByteArray for given bytes

fun EmptyCompletableDeferred.complete()

Completes an EmptyCompletableDeferred with Unit

fun <T> Iterable<T>.containsAny(elements: Iterable<T>): Boolean

Returns true if contains at least one element from elements

fun String.decodeHex(): ByteArray?

Converts a hex String to ByteArray

operator fun Decimal.div(value: Decimal): Decimal

Divides two Decimal.

fun Decimal.div(value: Decimal, scale: Int): Decimal

fun Decimal.div(value: Decimal, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Divides two Decimal to a given precision.

EmptyCompletableDeferred

fun EmptyCompletableDeferred(parent: Job? = null): EmptyCompletableDeferred

Creates a CompletableDeferred in an active state of typed Unit. In other words, it returns no value (either it will complete or throw an Exception). It is optionally a child of a parent job.

fun DefaultKalugaDate.Companion.epoch(offsetInMilliseconds: Long, timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDate

Creates a KalugaDate relative to January 1st 1970 00:00:00 GMT

inline fun <R> Sequence<*>.firstInstance(): R?

inline suspend fun <R> Flow<*>.firstInstance(): R?

Returns first element that is instance of specific type parameter R, or null if not found

getCompletedOrNull

fun <T> Deferred<T>.getCompletedOrNull(): T?

Gets the Deferred.getCompleted value if Deferred.isCompleted or null otherwise.

fun KalugaDate.isInSameYear(date: KalugaDate): Boolean

Checks whether a KalugaDate is in the same year as a given Date.

fun KalugaDate.isOnSameDay(date: KalugaDate): Boolean

Checks whether a KalugaDate is on the same day as a given Date.

fun KalugaDate.isOnSameMonth(date: KalugaDate): Boolean

Checks whether a KalugaDate is on the same month as a given Date.

fun Int.length(): Int

Determines the number of digits in an Integer

operator fun Decimal.minus(value: Decimal): Decimal

Subtracts two Decimal.

infix operator fun KalugaDate.minus(other: KalugaDate): Duration

Gets the Duration between two KalugaDate

infix operator fun KalugaDate.minus(duration: Duration): KalugaDate

Gets a KalugaDate that is duration before this date.

fun Decimal.minus(value: Decimal, scale: Int): Decimal

fun Decimal.minus(value: Decimal, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Subtracts two Decimal to a given precision.

fun DefaultKalugaDate.Companion.now(offsetInMilliseconds: Long, timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDate

Creates a KalugaDate relative to the current time

fun DefaultKalugaDate.Companion.nowUtc(offsetInMilliseconds: Long, locale: KalugaLocale = defaultLocale): KalugaDate

fun DefaultKalugaDate.Companion.nowUtc(offset: Duration = 0.milliseconds, locale: KalugaLocale = defaultLocale): KalugaDate

Creates a KalugaDate relative to the current time, in the UTC timezone

operator fun Decimal.plus(value: Decimal): Decimal

Adds two Decimal together.

infix operator fun KalugaDate.plus(duration: Duration): KalugaDate

Gets a KalugaDate that is duration after this date.

fun Decimal.plus(value: Decimal, scale: Int): Decimal

fun Decimal.plus(value: Decimal, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Adds two Decimal together scaled to a given precision.

infix fun Decimal.pow(n: Int): Decimal

Raises two Decimal.

fun Decimal.pow(n: Int, scale: Int): Decimal

fun Decimal.pow(n: Int, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Raises two Decimal to a given precision.

fun Decimal.round(scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Rounds a Decimal to a scale.

operator fun Decimal.times(value: Decimal): Decimal

Multiplies two Decimal.

fun Decimal.times(value: Decimal, scale: Int): Decimal

fun Decimal.times(value: Decimal, scale: Int, roundingMode: RoundingMode = RoundingMode.RoundHalfEven): Decimal

Multiplies two Decimal to a given precision.

fun <Error class: unknown class>.toByteArray(): ByteArray

Converts a NSData to its corresponding ByteArray

fun DefaultKalugaDate.Companion.today(timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDate

Gets a KalugaDate that is set at midnight on the same day as the current time.

fun Number.toDecimal(): Decimal

Converts a Number to a Decimal

fun String.toDecimal(): Decimal

Converts a String to a Decimal

fun ByteArray.toDecimalList(): List<Decimal>

Converts a ByteArray to a list of Decimal

fun DoubleArray.toDecimalList(): List<Decimal>

Converts a DoubleArray to a list of Decimal

fun FloatArray.toDecimalList(): List<Decimal>

Converts a FloatArray to a list of Decimal

fun IntArray.toDecimalList(): List<Decimal>

Converts an IntArray to a list of Decimal

fun LongArray.toDecimalList(): List<Decimal>

Converts a LongArray to a list of Decimal

fun ShortArray.toDecimalList(): List<Decimal>

Converts a ShortArray to a list of Decimal

fun <NumberType : Number> Collection<NumberType>.toDecimalList(): List<Decimal>

Converts a Collection of NumberType to a list of Decimal

fun Decimal.toDouble(): Double

Gets the double value of a Decimal

fun Collection<Decimal>.toDoubleArray(): DoubleArray

Converts a collection of Decimal to a DoubleArray

fun KalugaDate.toEndOfDay(): KalugaDate

Gets a KalugaDate equal to 23:59:59:999 on the same day as this Date

fun ByteArray.toHexString(separator: CharSequence = ""): String

Converts a ByteArray to a String representing the bytes as their hexadecimal value

fun Decimal.toInt(): Int

Gets the integer value of a Decimal

fun Collection<Decimal>.toIntArray(): IntArray

Converts a collection of Decimal to an IntArray

fun Decimal.toLong(): Long

Gets the long value of a Decimal

fun Collection<Decimal>.toLongArray(): LongArray

Converts a collection of Decimal to a LongArray

fun DefaultKalugaDate.Companion.tomorrow(timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDate

Gets a KalugaDate that is set at midnight on the day after the current time.

fun ByteArray.toNSData(): <Error class: unknown class>

Converts a ByteArray to its corresponding NSData

fun KalugaDate.toStartOfDay(): KalugaDate

Gets a KalugaDate equal to midnight on the same day as this Date

fun Decimal.toString(): String

Gets the string value of a Decimal

fun Collection<Decimal>.toStringList(): List<String>

Converts a collection of Decimal to a list of String

inline fun <T : Any> List<*>.typedList(): List<T>

Converts a list of unknown typing to a list of a given type. This proves useful since generics are lost when converting ObjC/Swift to Kotlin

inline fun <K : Any, V : Any> Map<*, *>.typedMap(): Map<K, V>

Converts a map of unknown typing to a map of a given key-value type. This proves useful since generics are lost when converting ObjC/Swift to Kotlin