t

com.avsystem.commons.misc

NamedEnumCompanion

trait NamedEnumCompanion[T <: NamedEnum] extends SealedEnumCompanion[T]

Base trait for companion objects of sealed traits that serve as named enums. NamedEnumCompanion is an extension of SealedEnumCompanion which additionally requires that every enum value has distinct string representation. Values can then be looked up by that representation using NamedEnumCompanion.byName

Example:

sealed abstract class Color(val name: String) extends NamedEnum
object Color extends NamedEnumCompanion[Color] {
  case object Red extends Color("red")
  case object Blue extends Color("blue")
  case object Green extends Color("green")

  // it's important to explicitly specify the type so that `caseObjects` macro works properly
  val values: List[Color] = caseObjects
}

NamedEnumCompanion also automatically provides implicit typeclass instances for GenKeyCodec and GenCodec.

Linear Supertypes
SealedEnumCompanion[T], AnyRef, Any
Known Subclasses
AbstractNamedEnumCompanion, AbstractValueEnumCompanion, ValueEnumCompanion, TextSearchLanguage, Aggregation, Overflow, BitOp, ClientType, DebugMode, Encoding, FailoverOption, GeoUnit, MaxmemoryPolicy, RedisMode, RedisType, ReplState, ShutdownModifier, SlaveState, SortOrder, UnblockModifier, MajorType, JsonType
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NamedEnumCompanion
  2. SealedEnumCompanion
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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.

  2. implicit lazy val codec: GenCodec[T]
  3. implicit def evidence: NamedEnumCompanion.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]