Enum

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

  val enum: Enum[Foo] = Enum[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

Linear Supertypes

AnyRef, Any

Known Subclasses

Derived

Abstract Value Members

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

returns
The value corresponding to the given label
abstract def encode(a: A): String

returns
The label of the given value a
abstract val labels: Set[String]

All the labels of the enumeration
abstract val values: Set[A]

All the values of the enumeration

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
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def decodeOpt(s: String): Option[A]

Convenient shorthand for decode that returns an Option[A]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
@throws( ... )

Related Docs: object Enum | package enum

trait Enum[A] extends AnyRef

Abstract Value Members

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

abstract def encode(a: A): String

abstract val labels: Set[String]

abstract val values: Set[A]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def decodeOpt(s: String): Option[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped