Trait

enumeratum.values

ValueEnum

Related Doc: package values

Permalink

sealed trait ValueEnum[ValueType, EntryType <: ValueEnumEntry[ValueType]] extends AnyRef

Base trait for a Value-based enums.

Example:

scala> sealed abstract class Greeting(val value: Int) extends IntEnumEntry

scala> object Greeting extends IntEnum[Greeting] {
     |   val values = findValues
     |   case object Hello   extends Greeting(1)
     |   case object GoodBye extends Greeting(2)
     |   case object Hi      extends Greeting(3)
     |   case object Bye     extends Greeting(4)
     | }

scala> Greeting.withValueOpt(1)
res0: Option[Greeting] = Some(Hello)

scala> Greeting.withValueOpt(6)
res1: Option[Greeting] = None
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValueEnum
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def values: IndexedSeq[EntryType]

    Permalink

    The sequence of values for your Enum.

    The sequence of values for your Enum. You will typically want to implement this in your extending class as a val so that withValue and friends are as efficient as possible.

    Feel free to implement this however you'd like (including messing around with ordering, etc) if that fits your needs better.

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final lazy val valuesToEntriesMap: Map[ValueType, EntryType]

    Permalink

    Map of ValueType to EntryType members

  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def withValue(i: ValueType): EntryType

    Permalink

    Tries to get an EntryType by the supplied value.

    Tries to get an EntryType by the supplied value. The value corresponds to the .value of the case objects implementing EntryType

    Like Enumeration's withValue, this method will throw if the value does not match any of the values' .value values.

    Annotations
    @SuppressWarnings()
  22. def withValueOpt(i: ValueType): Option[EntryType]

    Permalink

    Optionally returns an EntryType for a given value.

Inherited from AnyRef

Inherited from Any

Ungrouped