api/io.github.octaviusframework.db.api.util/CaseConvention

CaseConvention

enum CaseConvention : Enum<CaseConvention>

Supported naming conventions for automatic string conversion.

These conventions are primarily used during:

Mapping between Kotlin property names (camelCase) and PostgreSQL column names (snake_case).
Mapping between Kotlin Enum constants and their string representation in PostgreSQL.
Automatic generation of PostgreSQL type names from Kotlin class names.

Entries

SNAKE_CASE_UPPER

Uppercase words separated by underscores. Example: ON_MARCH, IN_BATTLE

SNAKE_CASE_LOWER

Lowercase words separated by underscores. Example: legion_status, province_name

PASCAL_CASE

Words concatenated together, each starting with an uppercase letter. Example: LegionStatus, ProvinceRecord

CAMEL_CASE

Words concatenated together, each except the first starting with an uppercase letter. Example: legionStatus, provinceRecord

Properties

entries

val entries: EnumEntries<CaseConvention>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): CaseConvention

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<CaseConvention>

Returns an array containing the constants of this enum type, in the order they're declared.