Trait

com.avsystem.commons.misc

TypedKeyCompanion

Related Doc: package misc

Permalink

trait TypedKeyCompanion[K[X] <: TypedKey[X]] extends SealedEnumCompanion[K[_]]

Linear Supertypes
SealedEnumCompanion[K[_]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TypedKeyCompanion
  2. SealedEnumCompanion
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. implicit abstract def keyCodec: GenKeyCodec[K[_]]

    Permalink

    GenKeyCodec for typed key K.

    GenKeyCodec for typed key K. You can implement this with GenKeyCodec.forSealedEnum macro

  2. abstract val values: commons.ISeq[K[_]]

    Permalink

    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. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. macro def caseObjects: List[K[_]]

    Permalink

    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

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. implicit val codecMapping: GenCodecMapping[K]

    Permalink

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. implicit def evidence: TypedKeyCompanion.this.type

    Permalink

    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

  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SealedEnumCompanion[K[_]]

Inherited from AnyRef

Inherited from Any

Ungrouped