base/com.splendo.kaluga.base.text

Package-level declarations

Types

BaseDateFormatter

interface BaseDateFormatter

Interface for parsing and formatting a KalugaDate from/to a String.

BaseNumberFormatter

interface BaseNumberFormatter

Class for parsing and formatting a Number from/to a String.

DateFormatStyle

enum DateFormatStyle : Enum<DateFormatStyle>

Style used for formatting a KalugaDate to and from a String

typealias ~~DateFormatter~~ = KalugaDateFormatter

enum Flag : Enum<Flag>

Modifying flags for a Formattable that modify the output

interface Formattable

Interface that adds support for an object to be formatted by StringFormatter.

KalugaDateFormatter

actual class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

expect class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

actual class KalugaDateFormatter

Default implementation of BaseDateFormatter

actual class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

actual class KalugaDateFormatter : BaseDateFormatter

Default implementation of BaseDateFormatter

NumberFormatStyle

@ExperimentalUnsignedTypes

sealed class NumberFormatStyle

Style used for formatting a Number to and from a String

NumberFormatter

@ExperimentalUnsignedTypes

actual class NumberFormatter(val locale: KalugaLocale, style: NumberFormatStyle) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

expect class NumberFormatter(locale: KalugaLocale = defaultLocale, style: NumberFormatStyle = NumberFormatStyle.Decimal()) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

actual class NumberFormatter

Default implementation of BaseNumberFormatter

actual class NumberFormatter(val locale: KalugaLocale, style: NumberFormatStyle) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

@ExperimentalUnsignedTypes

actual class NumberFormatter(val locale: KalugaLocale, style: NumberFormatStyle) : BaseNumberFormatter

Default implementation of BaseNumberFormatter

enum RoundingMode : Enum<RoundingMode>

Rounding mode applied when rounding aa given Number while formatting

StringFormatter

class StringFormatter(out: StringBuilder = StringBuilder(), locale: KalugaLocale = defaultLocale)

Formats a given String using a printf-style format strings. Supports formats for Number, String, Char, Boolean, and com.splendo.kaluga.base.utils.KalugaDate. Custom formatting is supported by implementing Formattable. Flags, precision and width are supported by this formatter as well. Formatting will adjust for a provided KalugaLocale. May throw a StringFormatterException if the incorrect format is applied.

StringFormatterException

sealed class StringFormatterException : Exception

List of exceptions that may be thrown by a StringFormatter.

Properties

actual val lineSeparator: String

The String that serves as a line separator.

expect val lineSeparator: String

The String that serves as a line separator.

actual val lineSeparator: String

The String that serves as a line separator.

actual val lineSeparator: String

The String that serves as a line separator.

actual val lineSeparator: String

The String that serves as a line separator.

Functions

fun KalugaDateFormatter.Companion.dateFormat(style: DateFormatStyle = DateFormatStyle.Medium, excludeYear: Boolean, timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDateFormatter

Creates a KalugaDateFormatter that only formats the date components of a KalugaDate

fun KalugaDateFormatter.Companion.dateTimeFormat(dateStyle: DateFormatStyle = DateFormatStyle.Medium, excludeYear: Boolean, timeStyle: DateFormatStyle = DateFormatStyle.Medium, timeZone: KalugaTimeZone = KalugaTimeZone.current(), locale: KalugaLocale = defaultLocale): KalugaDateFormatter

Creates a KalugaDateFormatter that formats both date and time components of a KalugaDate

fixedPatternFormat

fun KalugaDateFormatter.Companion.fixedPatternFormat(pattern: String, timeZone: KalugaTimeZone = KalugaTimeZone.current()): KalugaDateFormatter

Creates a fixed KalugaDateFormatter using a custom Date format pattern, localized by the KalugaLocale.enUsPosix. Use this to ensure that displaying time in 12 or 24 hour format is not overridden by the user.

fun String.format(vararg args: Any?, locale: KalugaLocale = defaultLocale): String

Formats this String as a printf-style format String using a variable number of arguments.

fun KalugaDateFormatter.Companion.iso8601Pattern(timeZone: KalugaTimeZone = KalugaTimeZone.current()): KalugaDateFormatter

Creates a KalugaDateFormatter that formats time according to the ISo 8601 format.

actual fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

expect fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

actual fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

actual fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

actual fun String.lowerCased(locale: KalugaLocale): String

Converts a String to its lower cased variant based on a given KalugaLocale

fun Set<Flag>.toString(): String

actual fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale

expect fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale

actual fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale

actual fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale

actual fun String.upperCased(locale: KalugaLocale): String

Converts a String to its upper cased variant based on a given KalugaLocale