core/com.hexagonkt.core

Package-level declarations

JVM information and other useful utilities.

Types

object Ansi

Constants for console formatting with ANSI codes. They can be used in strings to enable or disable a display option.

ClasspathHandler

object ClasspathHandler : URLStreamHandler

data class Glob(val pattern: String)

object Jvm

Object with utilities to gather information about the running JVM.

ResourceNotFoundException

class ResourceNotFoundException(message: String) : IOException

Functions

fun String.decodeBase64(): ByteArray

Decode this base64 encoded string.

fun ByteArray.encodeToBase64(): String

Encode the content of this byteArray to base64.

fun String.encodeToBase64(): String

Encode this string to base64.

fun URL.exists(): Boolean

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

fieldsMapOfNotNull

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

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

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

filterNotEmptyRecursive

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

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

filterStackTrace

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

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

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

fun freePort(): Int

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

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

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

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

getBooleansOrEmpty

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

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

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

getDoublesOrEmpty

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

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

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

getFloatsOrEmpty

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

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

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

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

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

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

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

getListsOrEmpty

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

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

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

getLongsOrEmpty

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

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

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

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

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

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

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

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

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

getStringsOrEmpty

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

fun inetAddress(vararg bytes: Byte): InetAddress

Syntactic sugar to create an Internet address.

fun isPortOpened(port: Int): Boolean

Check if a port is already opened.

fun URL.localized(locale: Locale): URL

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

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

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

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

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

fun <T : Any> String.parse(type: KClass<T>): T

fun <T : Any> String?.parseOrNull(type: KClass<T>): T?

fun String.prependIndent(count: Int = 4, pad: String = " "): String

fun <K, V> Map<K, V>.require(name: K): V

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

requireBooleans

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

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

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

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

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

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

fun Map<*, *>.requireInts(key: KProperty1<*, *>): List<Int>

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

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

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

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

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

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

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

inline fun <T : Any> Map<*, *>.requirePath(vararg name: Any): T

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

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

fun URL.responseCode(): Int

fun URL.responseFound(): Boolean

responseSuccessful

fun URL.responseSuccessful(): Boolean

fun String.stripAnsi(): String

fun String.toStream(): InputStream

fun Throwable.toText(prefix: String = ""): String

Return this throwable as a text.

fun urlOf(url: String): URL

Properties

val ALL_INTERFACES: InetAddress

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

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.

val eol: String

Runtime specific end of line.

val fail: Nothing

Syntax sugar to throw errors.

LOOPBACK_INTERFACE

val LOOPBACK_INTERFACE: InetAddress

Internet address used to bind services to the loopback interface.

val parsedClasses: Set<KClass<*>>

Supported types for the parseOrNull function.