core-utils/com.pambrose.common.util

Package-level declarations

Types

abstract class AbstractRepo(val scheme: String, val domainName: String, val ownerType: OwnerType, val ownerName: String, val repoName: String) : ContentRoot

Base class for Git repository content roots, providing URL construction for hosted repos.

ArrayUtils

object ArrayUtils

Utility object providing arrayPrint and asString overloads for all primitive array types and String arrays.

AtomicUtils

object AtomicUtils

Utility object providing extension functions for atomic types.

ContentRoot

interface ContentRoot

Root abstraction for a content location, either a local directory or a remote repository.

ContentSource

interface ContentSource

Represents a readable content source, either local or remote.

DateUtils

object DateUtils

Date/time parsing, formatting, and arithmetic helpers shared across all Kotlin targets.

FileSource

open class FileSource(val fileName: String) : ContentSource

A ContentSource that reads content from a local file.

FileSystemSource

class FileSystemSource(val pathPrefix: String) : ContentRoot

A ContentRoot backed by the local file system.

GitHubFile

open class GitHubFile(val repo: GitHubRepo, val branchName: String, val srcPath: String, val fileName: String, connectTimeout: Duration = DEFAULT_CONNECT_TIMEOUT, readTimeout: Duration = DEFAULT_READ_TIMEOUT) : UrlSource

A ContentSource pointing to a specific file in a GitHub repository.

GitHubRepo

class GitHubRepo(ownerType: OwnerType, ownerName: String, repoName: String, scheme: String = "https://", domainName: String = GITHUB) : AbstractRepo

A ContentRoot representing a GitHub repository.

GitLabFile

open class GitLabFile(val repo: GitLabRepo, val branchName: String, val srcPath: String, val fileName: String, connectTimeout: Duration = DEFAULT_CONNECT_TIMEOUT, readTimeout: Duration = DEFAULT_READ_TIMEOUT) : UrlSource

A ContentSource pointing to a specific file in a GitLab repository.

GitLabRepo

class GitLabRepo(ownerType: OwnerType, ownerName: String, repoName: String, scheme: String = "https://", domainName: String = "gitlab.com") : AbstractRepo

A ContentRoot representing a GitLab repository.

HostInfo

data class HostInfo(val hostName: String, val ipAddress: String)

Holds the hostname and IP address of the local machine.

ListUtils

object ListUtils

Utility object for list printing operations.

MiscFuncs

object MiscFuncs

Miscellaneous utility functions.

MiscJavaFuncs

open class MiscJavaFuncs

OwnerType

enum OwnerType : Enum<OwnerType>

Represents the type of owner for a Git repository.

ReadResources

object ReadResources

Utility for reading classpath resource files.

UrlSource

open class UrlSource(val source: String, connectTimeout: Duration = DEFAULT_CONNECT_TIMEOUT, readTimeout: Duration = DEFAULT_READ_TIMEOUT) : ContentSource

A ContentSource that reads content from a URL.

Version

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Version(val version: String, val releaseDate: String, val buildTime: Long)

Runtime annotation for embedding version metadata on a class.

Properties

asText

val ByteArray.asText: String

Converts this ByteArray to a lowercase hex string.

hostInfo

val hostInfo: HostInfo

Lazily resolved HostInfo for the local machine. Returns "Unknown" for both fields if the hostname cannot be determined.

length

val Int.length: Int

The number of decimal digits in this Int.

val Long.length: Int

The number of decimal digits in this Long, ignoring any minus sign.

simpleClassName

val <T : Any> T.simpleClassName: String

Returns the simple class name of this object, or "None" if unavailable (e.g., anonymous classes).

stackTraceAsString

val Throwable.stackTraceAsString: String

Converts this Throwable's stack trace to a String.

toPattern

val String.toPattern: String

Converts a glob-style pattern (using * and ? wildcards) to a regex pattern string.

typeParameterCount

val Any.typeParameterCount: Int

Returns the number of generic type parameters declared by this object's class.

Functions

asBracketed

fun String.asBracketed(startChar: Char = '[', endChar: Char = ']'): String

Wraps this String with startChar and endChar.

asRegex

fun String.asRegex(ignoreCase: Boolean = false): Regex

Converts this glob-style pattern string to a Regex.

capitalizeFirstChar

fun String.capitalizeFirstChar(): String

Capitalizes the first character of this String.

captureStdout

fun captureStdout(block: () -> Unit): String

Captures everything printed to System.out during execution of block and returns it as a String.

decode

fun String.decode(): String

URL-decodes this String using UTF-8 encoding.

encode

fun String.encode(): String

URL-encodes this String using UTF-8 encoding.

ensureLeadingSlash

fun String.ensureLeadingSlash(): String

Ensures this String starts with a leading /.

ensurePrefix

fun String.ensurePrefix(prefix: CharSequence): String

Ensures this String starts with prefix, prepending it if absent.

ensureSuffix

fun String.ensureSuffix(suffix: CharSequence): String

Ensures this String ends with suffix, appending it if absent.

firstLineNumberOf

fun String.firstLineNumberOf(regex: Regex): Int

Returns the 0-based line number of the first line matching regex, or -1 if not found.

fun List<String>.firstLineNumberOf(regex: Regex): Int

Returns the 0-based index of the first element matching regex, or -1 if not found.

getBanner

fun getBanner(filename: String, logger: KLogger): String

Loads a banner like getBanner, finding filename through the thread context classloader and falling back to logger's classloader.

@JvmOverloads

fun getBanner(filename: String, classLoader: ClassLoader = defaultResourceClassLoader()): String

Loads an ASCII art banner from a classpath resource file, trims leading/trailing blank lines, and indents each line for display.

isBracketed

fun String.isBracketed(startChar: Char = '[', endChar: Char = ']'): Boolean

Returns true if this trimmed String starts with startChar and ends with endChar.

isDouble

fun String.isDouble(): Boolean

Returns true if this String can be parsed as a Double.

isDoubleQuoted

fun String.isDoubleQuoted(): Boolean

Returns true if this trimmed String is wrapped in double quotes.

isFloat

fun String.isFloat(): Boolean

Returns true if this String can be parsed as a Float.

isInt

fun String.isInt(): Boolean

Returns true if this String can be parsed as an Int.

isNotBracketed

fun String.isNotBracketed(startChar: Char = '[', endChar: Char = ']'): Boolean

Returns true if this String is not bracketed by startChar and endChar.

isNotDouble

fun String.isNotDouble(): Boolean

Returns true if this String cannot be parsed as a Double.

isNotDoubleQuoted

fun String.isNotDoubleQuoted(): Boolean

Returns true if this trimmed String is not wrapped in double quotes.

isNotFloat

fun String.isNotFloat(): Boolean

Returns true if this String cannot be parsed as a Float.

isNotInt

fun String.isNotInt(): Boolean

Returns true if this String cannot be parsed as an Int.

isNotNull

fun Any?.isNotNull(): Boolean

Returns true if this value is not null, with a Kotlin contract that smart-casts the receiver.

isNotQuoted

fun String.isNotQuoted(): Boolean

Returns true if this String is not quoted.

isNotSingleQuoted

fun String.isNotSingleQuoted(): Boolean

Returns true if this trimmed String is not wrapped in single quotes.

isNull

fun Any?.isNull(): Boolean

Returns true if this value is null, with a Kotlin contract that smart-casts the receiver on false.

isQuoted

fun String.isQuoted(): Boolean

Returns true if this String is either single-quoted or double-quoted.

isSingleQuoted

fun String.isSingleQuoted(): Boolean

Returns true if this trimmed String is wrapped in single quotes.

join

fun List<String>.join(separator: CharSequence = "/"): String

Joins this list of strings into a path, adding no leading or trailing separator of its own: a separator the first element starts with, or the last one ends with, is kept.

lastLineNumberOf

fun String.lastLineNumberOf(regex: Regex): Int

Returns the 0-based line number of the last line matching regex, or -1 if not found.

fun List<String>.lastLineNumberOf(regex: Regex): Int

Returns the 0-based index of the last element matching regex, or -1 if not found.

linesBetween

fun String.linesBetween(start: Regex, end: Regex): List<String>

Returns the lines between the first match of start and the last match of end, exclusive.

fun List<String>.linesBetween(start: Regex, end: Regex): List<String>

Returns the elements between the first match of start and the last match of end, exclusive.

lpad

fun Int.lpad(width: Int, padChar: Char = '0'): String

Left-pads this Int to the specified width with padChar.

maskUrlCredentials

fun String.maskUrlCredentials(): String

Masks username and password in every URL in a string, replacing them with *****.

maxLength

fun String.maxLength(len: Int): String

Truncates this String to at most len characters.

md5

fun String.md5(salt: ByteArray): String

Computes the MD5 hash of this String with a byte array salt.

fun String.md5(salt: String = ""): String

Computes the MD5 hash of this String with an optional string salt.

md5Of

fun md5Of(vararg keys: Any, separator: String = "|"): String

Computes an MD5 hash of the given keys joined by separator.

newByteArraySalt

fun newByteArraySalt(len: Int = 16): ByteArray

Generates a cryptographically secure random byte array for use as a salt.

newStringSalt

fun newStringSalt(len: Int = 16): String

Generates a cryptographically secure random string for use as a salt.

nullIfBlank

fun String.nullIfBlank(): String?

Returns null if this String is blank, otherwise returns the string itself.

obfuscate

fun String.obfuscate(freq: Int = 2): String

Obfuscates this String by replacing characters at every freq-th position with '*'.

onFailureOrRethrow

inline fun <E : Throwable, T> Result<T>.onFailureOrRethrow(action: (Throwable) -> Unit): Result<T>

Like Result.onFailure, but rethrows exceptions of type E and invokes action for all others.

onFailureRethrowCancellation

inline fun <T> Result<T>.onFailureRethrowCancellation(action: (Throwable) -> Unit): Result<T>

Like Result.onFailure, but rethrows CancellationException to preserve coroutine cancellation.

pathOf

fun pathOf(vararg elems: Any): String

Joins the given elems into a /-separated path, filtering out empty elements.

pluralize

fun String.pluralize(cnt: Int, suffix: String = "s"): String

Appends suffix to this String when cnt is not 1 (simple English pluralization).

random

fun Int.random(): Int

Returns a random Int between 0 (inclusive) and this value (exclusive).

fun Long.random(): Long

Returns a random Long between 0 (inclusive) and this value (exclusive).

randomId

fun randomId(length: Int = 10, charPool: List<Char> = ('a'..'z') + ('A'..'Z') + ('0'..'9')): String

Generates a cryptographically secure random alphanumeric string.

readProperties

fun readProperties(fileNames: List<String>)

fun readProperties(vararg fileNames: String)

Reads key=value lines from each of fileNames and sets them as JVM system properties.

repeat

infix inline fun Int.repeat(block: (Int) -> Unit)

Repeats block this many times, passing the current iteration index.

repeatWithSleep

fun repeatWithSleep(iterations: Int, sleepTime: Duration = 1.seconds, block: (count: Int, startMillis: Long) -> Unit)

Repeatedly executes block with a sleep between each iteration.

rpad

fun Int.rpad(width: Int, padChar: Char = '0'): String

Right-pads this Int to the specified width with padChar.

runCatchingCancellable

inline fun <R> runCatchingCancellable(block: () -> R): Result<R>

Like runCatching, but rethrows CancellationException to preserve coroutine cancellation semantics.

sha256

fun String.sha256(salt: ByteArray): String

Computes the SHA-256 hash of this String with a byte array salt.

fun String.sha256(salt: String = ""): String

Computes the SHA-256 hash of this String with an optional string salt.

singleToDoubleQuoted

fun String.singleToDoubleQuoted(): String

Converts a single-quoted String to a double-quoted String. Surrounding whitespace is dropped, and inner backslashes and double quotes are backslash-escaped so the result is a well-formed double-quoted string. A string that is not single-quoted is returned unchanged.

sleep

fun sleep(sleepTime: Duration)

Suspends the current thread for the specified Duration.

substringBetween

fun String.substringBetween(begin: String, end: String): String

Returns the substring between the first occurrence of begin and the last occurrence of end.

times

infix inline operator fun Int.times(action: (Int) -> Unit)

Executes action for each value from 0 until this Int value.

infix inline operator fun Long.times(action: (Long) -> Unit)

Executes action for each value from 0 until this Long value.

infix inline operator fun Short.times(action: (Short) -> Unit)

Executes action for each value from 0 until this Short value.

toByteArray

fun Serializable.toByteArray(): ByteArray

Serializes this object with Java serialization.

toByteArraySecure

fun Serializable.toByteArraySecure(): ByteArray

Serializes this object with Java serialization; identical to toByteArray, kept for source compatibility.

toCsv

fun <T> Iterable<T>.toCsv(): String

Joins the elements of this Iterable into a comma-separated string.

toDoubleQuoted

fun String.toDoubleQuoted(): String

Wraps this String in double quotes.

toObject

fun ByteArray.~~toObject~~(): Serializable

Legacy deserialization method - DEPRECATED because deserializing untrusted bytes can execute arbitrary code. Use toObjectSecure instead.

toObjectSecure

fun <T : Serializable> ByteArray.toObjectSecure(expectedClass: Class<T>, allowedClasses: Set<Class<*>>): T

Deserialize with type validation and security checks.

toPath

fun List<String>.toPath(addPrefix: Boolean = true, addTrailing: Boolean = true, separator: CharSequence = "/"): String

Joins this list of strings into a path with configurable leading and trailing separators.

toRootPath

fun List<String>.toRootPath(addTrailing: Boolean = false, separator: CharSequence = "/"): String

Joins this list of strings into a root-relative path (with a leading separator).

toSingleQuoted

fun String.toSingleQuoted(): String

Wraps this String in single quotes.

trimEnds

fun String.trimEnds(len: Int = 1): String

Trims whitespace and removes len characters from both ends of this String.

verifyChecksum

fun ByteArray.verifyChecksum(): ByteArray

Verifies the SHA-256 checksum prepended by withChecksum and returns the data without it.

withChecksum

fun ByteArray.withChecksum(): ByteArray

Prepends a SHA-256 checksum of this data, for detecting accidental corruption.

withLineNumbers

fun String.withLineNumbers(separator: Char = ':'): String

Prepends line numbers to each line of this String.