kitecore/io.github.yuroyami.kitecore.text

Package-level declarations

Types

class StringFormatException(message: String) : IllegalArgumentException

Thrown when a portable JVM-style format string is malformed, lacks an argument, or uses an argument that is incompatible with its conversion.

Functions

appendIfMissing

fun String.appendIfMissing(suffix: String): String

Returns this string with suffix appended unless it already ends with suffix.

capitalizeFirst

fun String.capitalizeFirst(): String

Returns a copy of this string with its first character converted to upper case.

capitalizeWords

fun String.capitalizeWords(): String

Returns a copy of this string with the first character of every whitespace separated word converted to upper case.

collapseWhitespace

fun String.collapseWhitespace(): String

Replaces every run of whitespace in this string with a single space and removes leading and trailing whitespace.

containsAll

fun String.containsAll(vararg substrings: String, ignoreCase: Boolean = false): Boolean

Returns true when this string contains every element of substrings.

containsAny

fun String.containsAny(vararg substrings: String, ignoreCase: Boolean = false): Boolean

Returns true when this string contains at least one element of substrings.

countOccurrences

fun String.countOccurrences(substring: String): Int

Counts the non-overlapping occurrences of substring in this string.

decapitalizeFirst

fun String.decapitalizeFirst(): String

Returns a copy of this string with its first character converted to lower case.

digitsOnly

fun String.digitsOnly(): String

Returns a copy of this string containing only its digit characters.

dropLines

fun String.dropLines(n: Int): String

Returns the string without its first n lines. Dropping every line returns an empty string.

equalsAnyIgnoreCase

fun String.equalsAnyIgnoreCase(vararg candidates: String): Boolean

Returns true when this string equals at least one element of candidates, ignoring case.

firstLine

fun String.firstLine(): String

Returns the content of this string before its first line break, or the whole string when it contains no line break.

format

fun String.format(vararg args: Any?): String

Uses this string as a JVM-style format string and substitutes args.

fun String.Companion.format(format: String, vararg args: Any?): String

Formats format with args using KiteCore's portable JVM-style formatter.

indent

fun String.indent(spaces: Int): String

Prepends spaces space characters to every line of this string, including blank lines.

indexOfNth

fun String.indexOfNth(substring: String, n: Int): Int

Returns the index of the nth non-overlapping occurrence of substring, where n counts from 1, or -1 when there are fewer than n occurrences.

initials

fun String.initials(maxCount: Int = 2): String

Returns the upper cased first characters of up to maxCount whitespace separated words.

isAlpha

fun String.isAlpha(): Boolean

Returns true when this string is non-empty and every character is a letter.

isAlphanumeric

fun String.isAlphanumeric(): Boolean

Returns true when this string is non-empty and every character is a letter or a digit.

isHex

fun String.isHex(): Boolean

Returns true when this string is non-empty and every character is a hexadecimal digit (0-9, a-f, or A-F).

isNumeric

fun String.isNumeric(): Boolean

Returns true when this string is non-empty and every character is an ASCII digit.

isVowel

fun Char.isVowel(): Boolean

Returns true when this character is one of the ASCII vowels a, e, i, o, or u, in either case.

lastLine

fun String.lastLine(): String

Returns the content of this string after its last line break, or the whole string when it contains no line break.

lettersOnly

fun String.lettersOnly(): String

Returns a copy of this string containing only its letter characters.

lineCount

fun String.lineCount(): Int

Returns the number of lines in this string, treating \n, \r\n, and \r as line breaks.

mask

fun String.mask(visibleStart: Int = 0, visibleEnd: Int = 0, maskChar: Char = '*'): String

Replaces every character of this string with maskChar except the first visibleStart and the last visibleEnd characters.

nullIfBlank

fun String.nullIfBlank(): String?

Returns null when this string is blank, otherwise returns it unchanged.

nullIfEmpty

fun String.nullIfEmpty(): String?

Returns null when this string is empty, otherwise returns it unchanged.

padCenter

fun String.padCenter(length: Int, padChar: Char = ' '): String

Pads this string on both sides with padChar so that the result is length characters long, keeping the original content centered.

prependIfMissing

fun String.prependIfMissing(prefix: String): String

Returns this string with prefix prepended unless it already starts with prefix.

removePrefixIgnoreCase

fun String.removePrefixIgnoreCase(prefix: String): String

Removes prefix from the start of this string, comparing case insensitively.

removeSuffixIgnoreCase

fun String.removeSuffixIgnoreCase(suffix: String): String

Removes suffix from the end of this string, comparing case insensitively.

removeWhitespace

fun String.removeWhitespace(): String

Returns a copy of this string with every whitespace character removed.

splitCamelCase

fun String.splitCamelCase(): List<String>

Splits this string into its camel case segments.

splitToPair

fun String.splitToPair(delimiter: String): Pair<String, String>?

Splits this string at the first occurrence of delimiter into the part before it and the part after it, or returns null when delimiter is absent.

substringBetween

fun String.substringBetween(start: String, end: String): String?

Returns the substring after the first occurrence of start and before the next occurrence of end, or null when either delimiter is missing.

takeLines

fun String.takeLines(n: Int): String

Returns the first n lines joined with a line feed. Fewer lines return the whole string.

toBooleanOrDefault

fun String.toBooleanOrDefault(default: Boolean): Boolean

Parses this string as a boolean, returning default when it matches neither value.

toCamelCase

fun String.toCamelCase(): String

Converts this string to camelCase.

toDoubleOrDefault

fun String.toDoubleOrDefault(default: Double): Double

Parses this string as a Double, returning default when it is not a valid floating point number.

toFloatOrDefault

fun String.toFloatOrDefault(default: Float): Float

Parses this string as a Float, returning default when it is not a valid floating point number.

toIntOrDefault

fun String.toIntOrDefault(default: Int): Int

Parses this string as a decimal Int, returning default when it is not a valid integer.

toKebabCase

fun String.toKebabCase(): String

Converts this string to kebab-case.

toLongOrDefault

fun String.toLongOrDefault(default: Long): Long

Parses this string as a decimal Long, returning default when it is not a valid long integer.

toPascalCase

fun String.toPascalCase(): String

Converts this string to PascalCase.

toSlug

fun String.toSlug(): String

Converts this string to a lowercase ASCII slug.

toSnakeCase

fun String.toSnakeCase(): String

Converts this string to snake_case.

truncate

fun String.truncate(maxLength: Int, ellipsis: String = "..."): String

Shortens this string to at most maxLength characters, replacing the removed tail with ellipsis.

truncateMiddle

fun String.truncateMiddle(maxLength: Int, ellipsis: String = "..."): String

Shortens this string to at most maxLength characters by removing a middle section and inserting ellipsis in its place.

utf8Size

fun String.utf8Size(): Int

Returns the number of bytes this string occupies when encoded as UTF-8, computed from its code points without allocating an encoded copy.

wrap

fun String.wrap(maxLineLength: Int): String

Word wraps this string so that no line exceeds maxLineLength characters where possible.