Package com.hexagonkt.core

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.

Flags (System Properties)

DISABLE_CHECKS: set to true to disable some checks in order to shave a few ms. in production. Do not enable it in application development and turn it on only when the application is extensively tested.

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

CodedException

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

Exception with a numeric code.

Glob

data class Glob(val pattern: String)

TODO.

Jvm

object Jvm

Object with utilities to gather information about the running JVM.

MapResourceBundle

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

TODO.

MultiMap

class MultiMap<K, V>(mapData: Map<K, List<V>>) : Map<K, V>

Simplify access to multivalued maps. It looks for first elements, but all values can be accessed through the allValues field.

MultipleException

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

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

ResourceNotFoundException

class ResourceNotFoundException(message: String) : IOException

Functions

banner

fun String.banner(bannerDelimiter: String = "*"): String

Format the string as a banner with a delimiter above and below text. The character used to render the delimiter is defined.

bytes

fun UUID.bytes(): ByteArray

TODO.

camelToSnake

fun String.camelToSnake(): String

Transform the target string from camel case to snake case.

check

fun check(message: String = "Multiple exceptions", vararg blocks: () -> Unit)

TODO.

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.

ensureSize

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

TODO.

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 = false): String

TODO.

fieldsMapOf

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

TODO.

filter

fun String.filter( prefix: String, suffix: String, vararg parameters: Pair<String, *>): String

TODO.

filterEmpty

fun <V> List<V?>.filterEmpty(): List<V>

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

TODO.

filterEmptyRecursive

fun List<*>.filterEmptyRecursive(): List<*>

fun Map<*, *>.filterEmptyRecursive(): 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.

filterVars

fun String.filterVars(vararg parameters: Pair<*, *>): String

fun String.filterVars(parameters: Map<*, *>): String

Filter the target string substituting each key by its value. The keys format resembles Mustache's one: {{key}} and all occurrences are replaced by the supplied value.

findGroups

fun Regex.findGroups(text: String): List<MatchGroup>

TODO.

freePort

fun freePort(): Int

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

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.

multiMapOf

fun <K, V> multiMapOf(vararg pairs: Pair<K, V>): MultiMap<K, V>

multiMapOfLists

fun <K, V> multiMapOfLists(vararg pairs: Pair<K, List<V>>): MultiMap<K, V>

notEmpty

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

TODO.

prependIndent

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

TODO.

println

fun <T> T.println(prefix: String = ""): T

Print receiver to stdout. Convenient utility to debug variables quickly.

require

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

TODO.

requireKeys

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

TODO.

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.

snakeToCamel

fun String.snakeToCamel(): String

Transform the target string from snake case to camel case.

stripAccents

fun String.stripAccents(): String

TODO.

stripAnsi

fun String.stripAnsi(): String

toBase64

fun UUID.toBase64(): String

TODO.

toDate

fun LocalDate.toDate(): Date

Convert a local date to a date.

fun LocalDateTime.toDate(): Date

Convert a local date time to a date.

fun ZonedDateTime.toDate(): Date

Convert a zoned date time to a date.

toLocalDate

fun Date.toLocalDate(): LocalDate

Convert a date to a local date.

fun Int.toLocalDate(): LocalDate

Parse a date from a formatted integer with this format: YYYYMMDD.

toLocalDateTime

fun Date.toLocalDateTime(): LocalDateTime

Convert a date to a local date time.

fun Long.toLocalDateTime(): LocalDateTime

Parse a date time from a formatted number with this format: YYYYMMDDHHmmss.

toLocalTime

fun Int.toLocalTime(): LocalTime

Parse a time from a formatted integer with this format: HHmmssSSS.

toMultiMap

fun <K, V> Map<K, List<V>>.toMultiMap(): MultiMap<K, V>

toNumber

fun LocalDate.toNumber(): Int

Convert a date to an integer with the following format: YYYYMMDD.

fun LocalDateTime.toNumber(): Long

Convert a date time to a number with the following format: YYYYMMDDHHmmss.

fun LocalTime.toNumber(): Int

Convert a time to an integer with the following format: HHmmssSSS.

toStream

fun String.toStream(): InputStream

TODO.

toText

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

Return this throwable as a text.

utf8

fun utf8(vararg bytes: Int): String

TODO.

uuid

fun uuid(bytes: ByteArray): UUID

fun uuid(text: String): UUID

TODO.

withZone

fun LocalDateTime.withZone(zoneId: ZoneId = Jvm.timeZone.toZoneId()): ZonedDateTime

Return the date time in a given time zone for a local date time.

Properties

disableChecks

var disableChecks: Boolean

Disable heavy and optional checks in runtime. This flag can be enabled to get a small performance boost. Do NOT do this on development (it could mask problems) and enable it on production only if you have tested your application extensively.

eol

val eol: String

Runtime specific end of line.

fail

val fail: Nothing

Syntax sugar to throw errors.