Packages

trait Enum[A] extends AnyRef

sealed trait Foo
object Foo {
  case object Bar extends Foo
  case object Baz extends Foo

  val enum: Enum[Foo] = Enum.derived[Foo]
}

assert(Foo.enum.values == Set(Foo.Bar, Foo.Baz))
assert(Foo.enum.labels == Set("Bar", "Baz"))
assert(Foo.enum.encode(Foo.Bar) == "Bar")
assert(Foo.enum.decode("Baz") == Right(Foo.Baz))
assert(Foo.enum.decode("invalid") == Left(DecodingFailure[Foo](Set("Bar", "Baz"))))
A

Type of the enumeration values

Source
Enum.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Derived
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Enum
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decode(label: String): Either[DecodingFailure[A], A]

    returns

    The value corresponding to the given label

  2. abstract def encode(a: A): String

    returns

    The label of the given value a

  3. abstract val labels: Set[String]

    All the labels of the enumeration

  4. abstract val values: Set[A]

    All the values of the enumeration

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def decodeOpt(s: String): Option[A]

    Convenient shorthand for decode that returns an Option[A]

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped