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.
- Alphabetic
- By Inheritance
- NamedEnumCompanion
- SealedEnumCompanion
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
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 ofvalues
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
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. -
macro
def
caseObjects: List[T]
A macro which reifies a list of all case objects of the sealed trait or class
T
.A macro which reifies a list of all case objects of the sealed trait or class
T
. WARNING: the order of case objects in the resulting list is well defined only for enums that extend OrderedEnum. In such case, the order is consistent with declaration order in source file. However, if the enum is not an OrderedEnum, the order may be arbitrary.- Attributes
- protected
- Definition Classes
- SealedEnumCompanion
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- implicit lazy val codec: GenCodec[T]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit lazy val keyCodec: GenKeyCodec[T]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )