core/com.hexagonkt.core

Package-level declarations

JVM information and other useful utilities.

Classpath URLs in native images

To use the 'classpath' URL scheme on GraalVM native images, the native-image command requires to add the Classpath handler manually with the --enable-url-protocols=classpath parameter.

Types

Ansi

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

Glob

data class Glob(val pattern: String)

TODO.

Jvm

object Jvm

Object with utilities to gather information about the running JVM.

ResourceNotFoundException

class ResourceNotFoundException(message: String) : IOException

Functions

decodeBase64

fun String.decodeBase64(): ByteArray

Decode this base64 encoded string.

encodeToBase64

fun ByteArray.encodeToBase64(): String

Encode the content of this byteArray to base64.

fun String.encodeToBase64(): String

Encode this string to base64.

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.

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).

inetAddress

fun inetAddress(vararg bytes: Byte): InetAddress

Syntactic sugar to create an Internet address.

invoke

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

TODO.

isPortOpened

fun isPortOpened(port: Int): Boolean

Check if a port is already opened.

keys

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

TODO.

localized

fun URL.localized(locale: Locale): URL

mapOfNotNull

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

TODO.

parse

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

TODO.

parseOrNull

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

TODO.

prependIndent

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

TODO.

require

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

TODO.

requireKeys

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

TODO.

responseCode

fun URL.responseCode(): Int

responseFound

fun URL.responseFound(): Boolean

responseSuccessful

fun URL.responseSuccessful(): Boolean

stripAnsi

fun String.stripAnsi(): String

toStream

fun String.toStream(): InputStream

TODO.

toText

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

Return this throwable as a text.

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.

eol

val eol: String

Runtime specific end of line.

fail

val fail: Nothing

Syntax sugar to throw errors.

LOOPBACK_INTERFACE

val LOOPBACK_INTERFACE: InetAddress

Internet address used to bind services to the loopback interface.

parsedClasses

val parsedClasses: Set<KClass<*>>

Supported types for the parseOrNull function.