sealed-class-enumizer-runtime-api/io.github.projectmapk.sealedClassEnumizer

Package-level declarations

Types

Base type of the kinds generated for @Enumize hierarchies.

interface EnumishCompanion<out T : Enumish>

Hierarchy-wide operations over kinds — the enum-like static side (entries / valueOf), implemented by the companion object of each generated Enumish.

EnumishEntriesHolder

abstract class EnumishEntriesHolder<T : Enumish>

Base class of the per-hierarchy EntriesHolder the plugin generates: holds the entries list, its lazy initialization and the label lookup. User code normally goes through the generated Enumish companion (EnumishCompanion) instead of this type.

EnumishLabel

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class EnumishLabel(val value: String)

Overrides the label of the annotated leaf declaration.

Enumize

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Enumize(val labelCase: LabelCase = LabelCase.PROJECT_DEFAULT)

Instructs the sealed-class-enumizer compiler plugin to generate enum-like operations for the annotated sealed class or sealed interface.

Enumized

interface Enumized<out T : Enumish>

Supertype injected into every @Enumize hierarchy root, connecting values to their kinds.

LabelCase

enum LabelCase : Enum<LabelCase>

Case conversion applied to leaf simple names when deriving labels (Enumize.labelCase).

Properties

label

val <T : Enumish> Enumized<T>.label: String

Shortcut for asEnumish().label — the counterpart of Enum.name on the value side.