helpers/com.hexagontk.helpers

Package-level declarations

Platform information and other useful utilities. Includes basic program settings support at the Platform object (like loading and retrieving system settings).

Types

MapResourceBundle

abstract class MapResourceBundle(val map: Map<*, *>) : ListResourceBundle

TODO.

Properties

countryCodes

val countryCodes: Set<String>

Set of allowed country codes in this JVM.

currencyCodes

val currencyCodes: Set<String>

Set of allowed currency codes in this JVM.

languageCodes

val languageCodes: Set<String>

Set of allowed language codes in this JVM.

Functions

bytes

fun UUID.bytes(): ByteArray

TODO.

check

fun check(message: String, vararg blocks: () -> Unit)

Execute a list of code block collecting the exceptions they may throw, in case there is any error, it throws a MultipleException with all the thrown exceptions.

checkSize

fun <Z> Collection<Z>.checkSize(count: IntRange): Collection<Z>

Ensure a collection has a fixed number of elements.

countryOf

fun countryOf(country: String): Locale

countryOfOrNull

fun countryOfOrNull(country: String): Locale?

exec

fun String.exec(workingDirectory: File = File(System.getProperty("user.dir")), timeout: Long = Long.MAX_VALUE, fail: Boolean = false): String

TODO Add use case and example in documentation. TODO Support multiple words parameters by processing " and '

fun List<String>.exec(workingDirectory: File = File(System.getProperty("user.dir")), timeout: Long = Long.MAX_VALUE, fail: Boolean = true): String

TODO.

languageOf

fun languageOf(language: String): Locale

languageOfOrNull

fun languageOfOrNull(language: String): Locale?

localeOf

fun localeOf(language: String = "", country: String = ""): Locale

TODO.

localeOfOrNull

fun localeOfOrNull(language: String = "", country: String = ""): Locale?

TODO.

parseLocale

fun parseLocale(languageCountry: String): Locale

parseLocaleOrNull

fun parseLocaleOrNull(languageCountry: String): Locale?

properties

fun properties(url: URL): Map<String, String>

Load a '*.properties' file from a URL transforming the content into a plain map. If the resource can not be found, a com.hexagontk.core.ResourceNotFoundException is thrown.

requireGreater

fun <T : Any, N> T.requireGreater(field: KProperty1<T, Comparable<N>?>, min: N)

fun <T : Any, N> T.requireGreater(field: KProperty1<T, Comparable<N>?>, field2: KProperty1<T, N?>)

requireGreaterOrEquals

fun <T : Any, N> T.requireGreaterOrEquals(field: KProperty1<T, Comparable<N>?>, min: N)

fun <T : Any, N> T.requireGreaterOrEquals(field: KProperty1<T, Comparable<N>?>, field2: KProperty1<T, N?>)

requireLower

fun <T : Any, N> T.requireLower(field: KProperty1<T, Comparable<N>?>, min: N)

fun <T : Any, N> T.requireLower(field: KProperty1<T, Comparable<N>?>, field2: KProperty1<T, N?>)

requireLowerOrEquals

fun <T : Any, N> T.requireLowerOrEquals(field: KProperty1<T, Comparable<N>?>, min: N)

fun <T : Any, N> T.requireLowerOrEquals(field: KProperty1<T, Comparable<N>?>, field2: KProperty1<T, N?>)

requireNotBlank

fun <T : Any> T.requireNotBlank(field: KProperty1<T, CharSequence?>)

requireNotBlanks

fun <T : Any> T.requireNotBlanks(field: KProperty1<T, Collection<CharSequence>?>)

resourceBundle

inline fun <T : ResourceBundle> resourceBundle(locale: Locale = Locale.getDefault()): ResourceBundle

fun <T : ResourceBundle> resourceBundle(type: KClass<T>, locale: Locale = Locale.getDefault()): ResourceBundle

TODO.

retry

fun <T> retry(times: Int, delay: Long, block: () -> T): T

Execute a lambda until no exception is thrown or a number of times is reached.

shell

fun String.shell(workingDirectory: File = File(System.getProperty("user.dir")), timeout: Long = Long.MAX_VALUE, fail: Boolean = false): String

Executes a command in a shell (allowing to use pipes, redirections, etc.).

toBase64

fun UUID.toBase64(): String

TODO.

uuid

fun uuid(bytes: ByteArray): UUID

fun uuid(text: String): UUID

TODO.