core/com.hexagonkt.core

Package-level declarations

JVM information and other useful utilities. Includes basic program settings support at the api/core/com.hexagonkt.core/-jvm object (like loading and retrieving system settings).

Types

ClasspathHandler

object ClasspathHandler : URLStreamHandler

CodedException

class CodedException(val code: Int, message: String = "", cause: Throwable? = null) : RuntimeException

Exception with a numeric code.

Jvm

object Jvm

Object with utilities to gather information about the running JVM.

MapResourceBundle

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

TODO.

MultipleException

class MultipleException(val causes: List<Throwable>, message: String = "") : RuntimeException

Exception with a list of causes. Cause is null as it can't be told which one of the list is the cause.

OsKind

enum OsKind : Enum<OsKind>

ResourceNotFoundException

class ResourceNotFoundException(message: String) : IOException

Properties

ALL_INTERFACES

val ALL_INTERFACES: InetAddress

Internet address used to bind services to all local network interfaces.

assertEnabled

val assertEnabled: Boolean

This flag is true when assertions are enabled in the JVM (-ea flag). Assertions are disabled by default in the JVM, but they are enabled (and should be that way) on the tests.

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.

fail

val fail: Nothing

Syntax sugar to throw errors.

GMT_ZONE

val GMT_ZONE: ZoneId

GMT zone ID.

languageCodes

val languageCodes: Set<String>

Set of allowed language codes in this JVM.

LOOPBACK_INTERFACE

val LOOPBACK_INTERFACE: InetAddress

Internet address used to bind services to the loop-back interface.

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.

exists

fun URL.exists(): Boolean

fieldsMapOf

fun <T : Any> fieldsMapOf(vararg fields: Pair<KProperty1<T, *>, *>): Map<String, *>

TODO.

fieldsMapOfNotNull

fun <T : Any> fieldsMapOfNotNull(vararg fields: Pair<KProperty1<T, *>, *>): Map<String, *>

TODO.

filterNotEmpty

fun <V> Collection<V?>.filterNotEmpty(): Collection<V>

fun <K, V> Map<K, V?>.filterNotEmpty(): Map<K, V>

TODO.

filterNotEmptyRecursive

fun Collection<*>.filterNotEmptyRecursive(): Collection<*>

fun Map<*, *>.filterNotEmptyRecursive(): Map<*, *>

TODO.

filterStackTrace

fun Throwable.filterStackTrace(prefix: String): Array<out StackTraceElement>

Return the stack trace array of the frames that starts with the given prefix.

firstVariant

fun URL.firstVariant(vararg suffixes: String): URL

freePort

fun freePort(): Int

Return a random free port (not used by any other local process).

get

inline operator fun <T : Any> Map<*, *>.get(key: KProperty1<*, *>): T?

TODO.

getBoolean

fun Map<*, *>.getBoolean(key: KProperty1<*, *>): Boolean?

getBooleans

fun Map<*, *>.getBooleans(key: KProperty1<*, *>): Collection<Boolean>?

getBooleansOrEmpty

fun Map<*, *>.getBooleansOrEmpty(key: KProperty1<*, *>): Collection<Boolean>

getDouble

fun Map<*, *>.getDouble(key: KProperty1<*, *>): Double?

getDoubles

fun Map<*, *>.getDoubles(key: KProperty1<*, *>): Collection<Double>?

getDoublesOrEmpty

fun Map<*, *>.getDoublesOrEmpty(key: KProperty1<*, *>): Collection<Double>

getFloat

fun Map<*, *>.getFloat(key: KProperty1<*, *>): Float?

getFloats

fun Map<*, *>.getFloats(key: KProperty1<*, *>): Collection<Float>?

getFloatsOrEmpty

fun Map<*, *>.getFloatsOrEmpty(key: KProperty1<*, *>): Collection<Float>

getInt

fun Map<*, *>.getInt(key: KProperty1<*, *>): Int?

getInts

fun Map<*, *>.getInts(key: KProperty1<*, *>): Collection<Int>?

getIntsOrEmpty

fun Map<*, *>.getIntsOrEmpty(key: KProperty1<*, *>): Collection<Int>

getList

fun Map<*, *>.getList(key: KProperty1<*, *>): Collection<*>?

getListOrEmpty

fun Map<*, *>.getListOrEmpty(key: KProperty1<*, *>): Collection<*>

getLists

fun Map<*, *>.getLists(key: KProperty1<*, *>): Collection<List<*>>?

getListsOrEmpty

fun Map<*, *>.getListsOrEmpty(key: KProperty1<*, *>): Collection<Collection<*>>

getLong

fun Map<*, *>.getLong(key: KProperty1<*, *>): Long?

getLongs

fun Map<*, *>.getLongs(key: KProperty1<*, *>): Collection<Long>?

getLongsOrEmpty

fun Map<*, *>.getLongsOrEmpty(key: KProperty1<*, *>): Collection<Long>

getMap

fun Map<*, *>.getMap(key: KProperty1<*, *>): Map<String, *>?

getMapOrEmpty

fun Map<*, *>.getMapOrEmpty(key: KProperty1<*, *>): Map<String, *>

getMaps

fun Map<*, *>.getMaps(key: KProperty1<*, *>): Collection<Map<String, *>>?

getMapsOrEmpty

fun Map<*, *>.getMapsOrEmpty(key: KProperty1<*, *>): Collection<Map<String, *>>

getOrDefault

inline fun <T : Any> Map<*, *>.getOrDefault(key: KProperty1<*, *>, default: T): T

TODO.

getPath

inline fun <T : Any> Map<*, *>.getPath(vararg keys: Any): T?

TODO.

getString

fun Map<*, *>.getString(key: KProperty1<*, *>): String?

getStrings

fun Map<*, *>.getStrings(key: KProperty1<*, *>): Collection<String>?

getStringsOrEmpty

fun Map<*, *>.getStringsOrEmpty(key: KProperty1<*, *>): Collection<String>

inetAddress

fun inetAddress(vararg bytes: Byte): InetAddress

Syntactic sugar to create an Internet address.

isPortOpened

fun isPortOpened(port: Int): Boolean

Check if a port is already opened.

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.

localized

fun URL.localized(locale: Locale): URL

mapOfNotNull

fun <K : Any> mapOfNotNull(vararg pairs: Pair<K, *>): Map<K, *>

TODO.

merge

fun merge(maps: Collection<Map<*, *>>): Map<*, *>

fun merge(mapA: Map<*, *>, mapB: Map<*, *>): Map<*, *>

TODO.

notEmpty

fun <V> notEmpty(value: V?): Boolean

TODO.

pairs

fun <K, V> Map<K, Collection<V>>.pairs(): Collection<Pair<K, V>>

TODO.

parseDuration

fun parseDuration(text: String): Duration

Parse a time duration allowing a more relaxed format: with spaces or commas, lowercase characters and not forcing the text to start with 'P', however, the 'T' is still mandatory to separate date and time durations.

parseLocalDate

fun parseLocalDate(text: String): LocalDate

Parse a local date allowing only to specify the year or the year and the month. Missing month and day will be defaulted to january and one respectively.

parseLocale

fun parseLocale(languageCountry: String): Locale

parseLocaleOrNull

fun parseLocaleOrNull(languageCountry: String): Locale?

parsePeriod

fun parsePeriod(text: String): Period

Parse a time period allowing a more relaxed format: with spaces or commas, lowercase characters and not forcing the text to start with 'P'.

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.hexagonkt.core.ResourceNotFoundException is thrown.

require