c

com.avsystem.commons.misc

AbstractNamedEnumCompanion

abstract class AbstractNamedEnumCompanion[T <: NamedEnum] extends AbstractSealedEnumCompanion[T] with NamedEnumCompanion[T]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractNamedEnumCompanion
  2. NamedEnumCompanion
  3. AbstractSealedEnumCompanion
  4. SealedEnumCompanion
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractNamedEnumCompanion()

Abstract Value Members

  1. abstract val values: commons.ISeq[T]

    Holds a list of all case objects of a sealed trait or class T.

    Holds a list of all case objects of a sealed trait or class T. This must be implemented separately for every sealed enum, but can be implemented simply by using the caseObjects macro. It's important to *always* state the type of values explicitly, as a workaround for SI-7046. For example:

    val values: List[MyEnum] = caseObjects

    Also, be aware that caseObjects macro guarantees well-defined order of elements only for OrderedEnum.

    Definition Classes
    SealedEnumCompanion

Concrete Value Members

  1. lazy val byName: Map[String, T]

    Returns a map from all case objects names to their instances.

    Returns a map from all case objects names to their instances. Since byName uses caseObjects macro it does NOT guarantee an order of elements. It is also essential to provide unique names for each case object in the sealed hierarchy to retrieve valid hierarchy.

    Definition Classes
    NamedEnumCompanion
  2. implicit lazy val codec: GenCodec[T]
    Definition Classes
    NamedEnumCompanion
  3. implicit def evidence: AbstractNamedEnumCompanion.this.type

    Thanks to this implicit, SealedEnumCompanion and its subtraits can be used as typeclasses.

    Thanks to this implicit, SealedEnumCompanion and its subtraits can be used as typeclasses.

    Definition Classes
    SealedEnumCompanion
  4. implicit lazy val keyCodec: GenKeyCodec[T]
    Definition Classes
    NamedEnumCompanion