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.

object ArrayUtils

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

object AtomicUtils

Utility object providing extension functions for atomic types.

interface ContentRoot

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

interface ContentSource

Represents a readable content source, either local or remote.

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.

open class GitHubFile(val repo: GitHubRepo, val branchName: String, val srcPath: String, val fileName: String) : UrlSource

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

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

A ContentRoot representing a GitHub repository.

open class GitLabFile(val repo: GitLabRepo, val branchName: String, val srcPath: String, val fileName: String) : UrlSource

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

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

A ContentRoot representing a GitLab repository.

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

Holds the hostname and IP address of the local machine.

object ListUtils

Utility object for list printing operations.

object MiscFuncs

Miscellaneous utility functions.

open class MiscJavaFuncs

enum OwnerType : Enum<OwnerType>

Represents the type of owner for a Git repository.

object ReadResources

Utility for reading classpath resource files.

open class UrlSource(val source: String) : ContentSource

A ContentSource that reads content from a URL.

@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

val ByteArray.asText: String

Converts this ByteArray to a lowercase hex string.

val hostInfo: HostInfo

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

val Int.length: Int

The number of decimal digits in this Int.

val Long.length: Int

The number of decimal digits in this Long.

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.

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 of this object's class.

Functions

abbrevDayOfWeek

fun LocalDateTime.abbrevDayOfWeek(): String

Returns the abbreviated day-of-week name (e.g., "Mon", "Tue").

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

Wraps this String with startChar and endChar.

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.

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

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

fun String.decode(): String

URL-decodes this String using UTF-8 encoding.

fun String.encode(): String

URL-encodes this String using UTF-8 encoding.

ensureLeadingSlash

fun String.ensureLeadingSlash(): String

Ensures this String starts with a leading /.

fun String.ensurePrefix(prefix: CharSequence): String

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

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.

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

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

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

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

fun String.isDouble(): Boolean

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

fun String.isDoubleQuoted(): Boolean

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

fun String.isFloat(): Boolean

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

fun String.isInt(): Boolean

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

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

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

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.

fun String.isNotFloat(): Boolean

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

fun String.isNotInt(): Boolean

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

fun Any?.isNotNull(): Boolean

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

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.

fun Any?.isNull(): Boolean

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

fun String.isQuoted(): Boolean

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

fun String.isSingleQuoted(): Boolean

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

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

Joins this list of strings into a path without leading or trailing separators.

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.

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.

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 a URL string, replacing them with *****.

fun String.maxLength(len: Int): String

Truncates this String to at most len characters.

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.

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.

fun newStringSalt(len: Int = 16): String

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

fun String.nullIfBlank(): String?

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

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.

fun pathOf(vararg elems: Any): String

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

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

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

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

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

Generates a cryptographically secure random alphanumeric string.

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.

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.

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, escaping inner double quotes.

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.

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.

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

Legacy serialization method - DEPRECATED due to security vulnerabilities. Use toByteArraySecure() instead.

toByteArraySecure

fun Serializable.toByteArraySecure(): ByteArray

Secure serialization using Java serialization.

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

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

fun String.toDoubleQuoted(): String

Wraps this String in double quotes.

toFullDateString

fun LocalDateTime.toFullDateString(): String

Formats this LocalDateTime as a full date string, e.g., "Mon 04/10/26 14:30:00 PST".

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

Legacy deserialization method - DEPRECATED due to security vulnerabilities. Use toObjectSecure() instead.

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

Deserialize with type validation and security checks.

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.

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

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

fun String.toSingleQuoted(): String

Wraps this String in single quotes.

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

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

fun ByteArray.verifyChecksum(): ByteArray

Verify SHA-256 checksum and return data without checksum.

fun ByteArray.withChecksum(): ByteArray

Add SHA-256 checksum to data for integrity verification.

withLineNumbers

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

Prepends line numbers to each line of this String.