enumeratum.values

Members list

Type members

Classlikes

object ByteEnum

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
ByteEnum.type
trait ByteEnum[A <: ByteEnumEntry] extends ValueEnum[Byte, A]

Value enum with ByteEnumEntry entries

Value enum with ByteEnumEntry entries

This is similar to enumeratum.Enum, but different in that values must be literal values. This restraint allows us to enforce uniqueness at compile time.

Note that uniqueness is only guaranteed if you do not do any runtime string manipulation on values.

Attributes

Companion
object
Supertypes
trait ValueEnum[Byte, A]
class Object
trait Matchable
class Any
abstract class ByteEnumEntry extends ValueEnumEntry[Byte]

Value Enum Entry parent class for Byte valued entries

Value Enum Entry parent class for Byte valued entries

Attributes

Supertypes
trait ValueEnumEntry[Byte]
class Object
trait Matchable
class Any
object CharEnum

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
CharEnum.type
trait CharEnum[A <: CharEnumEntry] extends ValueEnum[Char, A]

Value enum with CharEnumEntry entries

Value enum with CharEnumEntry entries

This is similar to enumeratum.Enum, but different in that values must be literal values. This restraint allows us to enforce uniqueness at compile time.

Note that uniqueness is only guaranteed if you do not do any runtime string manipulation on values.

Attributes

Companion
object
Supertypes
trait ValueEnum[Char, A]
class Object
trait Matchable
class Any
abstract class CharEnumEntry extends ValueEnumEntry[Char]

Value Enum Entry parent class for Char valued entries

Value Enum Entry parent class for Char valued entries

Attributes

Supertypes
trait ValueEnumEntry[Char]
class Object
trait Matchable
class Any
object IntEnum

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
IntEnum.type
trait IntEnum[A <: IntEnumEntry] extends ValueEnum[Int, A]

Value enum with IntEnumEntry entries

Value enum with IntEnumEntry entries

Attributes

Companion
object
Supertypes
trait ValueEnum[Int, A]
class Object
trait Matchable
class Any
abstract class IntEnumEntry extends ValueEnumEntry[Int]

Value Enum Entry parent class for Int valued entries

Value Enum Entry parent class for Int valued entries

Attributes

Supertypes
trait ValueEnumEntry[Int]
class Object
trait Matchable
class Any
object LongEnum

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
LongEnum.type
trait LongEnum[A <: LongEnumEntry] extends ValueEnum[Long, A]

Value enum with LongEnumEntry entries

Value enum with LongEnumEntry entries

Attributes

Companion
object
Supertypes
trait ValueEnum[Long, A]
class Object
trait Matchable
class Any
abstract class LongEnumEntry extends ValueEnumEntry[Long]

Value Enum Entry parent class for Long valued entries

Value Enum Entry parent class for Long valued entries

Attributes

Supertypes
trait ValueEnumEntry[Long]
class Object
trait Matchable
class Any
final case class NoSuchMember[ValueType, A <: ValueEnumEntry[ValueType]](notFoundValue: ValueType, enumValues: IndexedSeq[A]) extends NoSuchElementException, NoStackTrace

Attributes

Supertypes
trait Product
trait Equals
trait NoStackTrace
class NoSuchElementException
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object ShortEnum

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
ShortEnum.type
trait ShortEnum[A <: ShortEnumEntry] extends ValueEnum[Short, A]

Value enum with ShortEnumEntry entries

Value enum with ShortEnumEntry entries

Attributes

Companion
object
Supertypes
trait ValueEnum[Short, A]
class Object
trait Matchable
class Any
abstract class ShortEnumEntry extends ValueEnumEntry[Short]

Value Enum Entry parent class for Short valued entries

Value Enum Entry parent class for Short valued entries

Attributes

Supertypes
trait ValueEnumEntry[Short]
class Object
trait Matchable
class Any
object StringEnum

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
StringEnum.type
trait StringEnum[A <: StringEnumEntry] extends ValueEnum[String, A]

Value enum with StringEnumEntry entries

Value enum with StringEnumEntry entries

This is similar to enumeratum.Enum, but different in that values must be literal values. This restraint allows us to enforce uniqueness at compile time.

Note that uniqueness is only guaranteed if you do not do any runtime string manipulation on values.

Attributes

Companion
object
Supertypes
trait ValueEnum[String, A]
class Object
trait Matchable
class Any
abstract class StringEnumEntry extends ValueEnumEntry[String]

Value Enum Entry parent class for String valued entries

Value Enum Entry parent class for String valued entries

This is similar to enumeratum.Enum, but different in that values must be literal values. This restraint allows us to enforce uniqueness at compile time.

Note that uniqueness is only guaranteed if you do not do any runtime string manipulation on values.

Attributes

Supertypes
trait ValueEnumEntry[String]
class Object
trait Matchable
class Any
sealed trait ValueEnum[ValueType, EntryType <: ValueEnumEntry[ValueType]]

Base trait for a Value-based enums.

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ByteEnum[A]
trait CharEnum[A]
trait IntEnum[A]
trait LongEnum[A]
trait ShortEnum[A]
trait StringEnum[A]
Show all
sealed trait ValueEnumEntry[ValueType]

Created by Lloyd on 4/11/16.

Created by Lloyd on 4/11/16.

Copyright 2016

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type