scala

Enumeration

abstract class Enumeration extends Serializable

Defines a finite set of values specific to the enumeration. Typically these values enumerate all possible forms something can take and provide a lightweight alternative to case classes.

Each call to a Value method adds a new unique value to the enumeration. To be accessible, these values are usually defined as val members of the evaluation.

All values in an enumeration share a common, unique type defined as the Value type member of the enumeration (Value selected on the stable identifier path of the enumeration instance).

Self Type
Enumeration
Annotations
@SerialVersionUID()
Source
Enumeration.scala
Example: 

  1. object Main extends App {

  object WeekDay extends Enumeration {
    type WeekDay = Value
    val Mon, Tue, Wed, Thu, Fri, Sat, Sun = Value
  }
  import WeekDay._

  def isWorkingDay(d: WeekDay) = ! (d == Sat || d == Sun)

  WeekDay.values filter isWorkingDay foreach println
}
// output:
// Mon
// Tue
// Wed
// Thu
// Fri
Linear Supertypes
Serializable, java.io.Serializable, AnyRef, Any
Known Subclasses
Alignment, Alignment, Anchor, AutoResizeMode, BarPolicy, ElementMode, Fill, FocusLostBehavior, IntervalMode, IntervalMode, Key, Layout, Location, Message, MinimizeMode, Options, Orientation, Position, Result, Result, RoundingMode, SelectionMode, State
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Enumeration
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Enumeration()

  2. new Enumeration(initial: Int)

    initial

    The initial value from which to count the integers that identifies values at run-time.

Type Members

  1. class Val extends Value with Serializable

    A class implementing the scala.Enumeration.Value type.

  2. abstract class Value extends Ordered[Value] with Serializable

    The type of the enumerated values.

  3. class ValueSet extends AbstractSet[Value] with SortedSet[Value] with SortedSetLike[Value, ValueSet] with Serializable

    A class for sets of values.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Enumeration to StringAdd[Enumeration] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Enumeration, B)

    Implicit information
    This member is added by an implicit conversion from Enumeration to ArrowAssoc[Enumeration] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  8. final def Value(i: Int, name: String): Value

    Creates a fresh value, part of this enumeration, called name and identified by the integer i.

    Creates a fresh value, part of this enumeration, called name and identified by the integer i.

    i

    An integer that identifies this value at run-time. It must be unique amongst all values of the enumeration.

    name

    A human-readable name for that value.

    returns

    Fresh value with the provided identifier i and name name.

    Attributes
    protected

  9. final def Value(name: String): Value

    Creates a fresh value, part of this enumeration, called name.

    Creates a fresh value, part of this enumeration, called name.

    name

    A human-readable name for that value.

    returns

    Fresh value called name.

    Attributes
    protected

  10. final def Value(i: Int): Value

    Creates a fresh value, part of this enumeration, identified by the integer i.

    Creates a fresh value, part of this enumeration, identified by the integer i.

    i

    An integer that identifies this value at run-time. It must be unique amongst all values of the enumeration.

    returns

    Fresh value identified by i.

    Attributes
    protected

  11. final def Value: Value

    Creates a fresh value, part of this enumeration.

    Creates a fresh value, part of this enumeration.

    Attributes
    protected

  12. object ValueOrdering extends Ordering[Value]

    An ordering by id for values of this set

  13. object ValueSet extends Serializable

    A factory object for value sets

  14. final def apply(x: Int): Value

    The value of this enumeration with given id x

  15. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  16. def clone(): AnyRef

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

  17. def ensuring(cond: (Enumeration) ⇒ Boolean, msg: ⇒ Any): Enumeration

    Implicit information
    This member is added by an implicit conversion from Enumeration to Ensuring[Enumeration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  18. def ensuring(cond: (Enumeration) ⇒ Boolean): Enumeration

    Implicit information
    This member is added by an implicit conversion from Enumeration to Ensuring[Enumeration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  19. def ensuring(cond: Boolean, msg: ⇒ Any): Enumeration

    Implicit information
    This member is added by an implicit conversion from Enumeration to Ensuring[Enumeration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  20. def ensuring(cond: Boolean): Enumeration

    Implicit information
    This member is added by an implicit conversion from Enumeration to Ensuring[Enumeration] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  23. def finalize(): Unit

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

  24. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from Enumeration to StringFormat[Enumeration] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  28. final def maxId: Int

    The one higher than the highest integer amongst those used to identify values in this enumeration.

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

    Definition Classes
    AnyRef

  30. var nextId: Int

    The integer to use to identify the next created value.

    The integer to use to identify the next created value.

    Attributes
    protected

  31. var nextName: Iterator[String]

    The string to use to name the next created value.

    The string to use to name the next created value.

    Attributes
    protected

  32. final def notify(): Unit

    Definition Classes
    AnyRef

  33. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  34. def readResolve(): AnyRef

    Attributes
    protected

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

    Definition Classes
    AnyRef

  36. def toString(): String

    The name of this enumeration.

    The name of this enumeration.

    Definition Classes
    Enumeration → AnyRef → Any

  37. def values: ValueSet

    The values of this enumeration as a set.

  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  41. final def withName(s: String): Value

    Return a Value from this Enumeration whose name matches the argument s.

    Return a Value from this Enumeration whose name matches the argument s. The names are determined automatically via reflection.

    s

    an Enumeration name

    returns

    the Value of this Enumeration if its name matches s

    Exceptions thrown
    NoSuchElementException

    if no Value with a matching name is in this Enumeration

  42. def →[B](y: B): (Enumeration, B)

    Implicit information
    This member is added by an implicit conversion from Enumeration to ArrowAssoc[Enumeration] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Enumeration to StringAdd[Enumeration]

Inherited by implicit conversion StringFormat from Enumeration to StringFormat[Enumeration]

Inherited by implicit conversion Ensuring from Enumeration to Ensuring[Enumeration]

Inherited by implicit conversion ArrowAssoc from Enumeration to ArrowAssoc[Enumeration]

Ungrouped