Packages

  • package root

    This is the documentation for the Scala standard library.

    This is the documentation for the Scala standard library.

    Package structure

    The scala package contains core types like Int, Float, Array or Option which are accessible in all Scala compilation units without explicit qualification or imports.

    Notable packages include:

    Other packages exist. See the complete list on the right.

    Additional parts of the standard library are shipped as separate libraries. These include:

    Automatic imports

    Identifiers in the scala package and the scala.Predef object are always in scope by default.

    Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, List is an alias for scala.collection.immutable.List.

    Other aliases refer to classes provided by the underlying platform. For example, on the JVM, String is an alias for java.lang.String.

    Definition Classes
    root
  • package scala

    Core Scala types.

    Core Scala types. They are always available without an explicit import.

    Definition Classes
    root
  • abstract class Enumeration extends Serializable

    Defines a finite set of values specific to the enumeration.

    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 enumeration.

    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).

    Values SHOULD NOT be added to an enumeration after its construction; doing so makes the enumeration thread-unsafe. If values are added to an enumeration from multiple threads (in a non-synchronized fashion) after construction, the behavior of the enumeration is undefined.

    Definition Classes
    scala
    Annotations
    @SerialVersionUID()
    Examples:

    1. // Define a new enumeration with a type alias and work with the full set of enumerated values
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
      2. , 

    2. // Example of adding attributes to an enumeration by extending the Enumeration.Val class
object Planet extends Enumeration {
  protected case class PlanetVal(mass: Double, radius: Double) extends super.Val {
    def surfaceGravity: Double = Planet.G * mass / (radius * radius)
    def surfaceWeight(otherMass: Double): Double = otherMass * surfaceGravity
  }
  import scala.language.implicitConversions
  implicit def valueToPlanetVal(x: Value): PlanetVal = x.asInstanceOf[PlanetVal]

  val G: Double = 6.67300E-11
  val Mercury = PlanetVal(3.303e+23, 2.4397e6)
  val Venus   = PlanetVal(4.869e+24, 6.0518e6)
  val Earth   = PlanetVal(5.976e+24, 6.37814e6)
  val Mars    = PlanetVal(6.421e+23, 3.3972e6)
  val Jupiter = PlanetVal(1.9e+27, 7.1492e7)
  val Saturn  = PlanetVal(5.688e+26, 6.0268e7)
  val Uranus  = PlanetVal(8.686e+25, 2.5559e7)
  val Neptune = PlanetVal(1.024e+26, 2.4746e7)
}

println(Planet.values.filter(_.radius > 7.0e6))
// output:
// Planet.ValueSet(Jupiter, Saturn, Uranus, Neptune)
  • Val
  • Value
  • ValueOrdering
  • ValueSet

object ValueSet extends SpecificIterableFactory[Value, ValueSet] with java.io.Serializable

A factory object for value sets

Annotations
@SerialVersionUID()
Source
Enumeration.scala
Linear Supertypes
java.io.Serializable, SpecificIterableFactory[Value, ValueSet], Factory[Value, ValueSet], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ValueSet
  2. Serializable
  3. SpecificIterableFactory
  4. Factory
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def apply(xs: Value*): ValueSet
    Definition Classes
    SpecificIterableFactory
  2. val empty: ValueSet

    The empty value set

    The empty value set

    Definition Classes
    ValueSet → SpecificIterableFactory
  3. def fill(n: Int)(elem: => Value): ValueSet
    Definition Classes
    SpecificIterableFactory
  4. def fromBitMask(elems: Array[Long]): ValueSet

    A value set containing all the values for the zero-adjusted ids corresponding to the bits in an array

  5. def fromSpecific(it: IterableOnce[Value]): ValueSet

    it

    Source collection

    returns

    A collection of type C containing the same elements as the source collection it.

    Definition Classes
    ValueSet → Factory
  6. def newBuilder: Builder[Value, ValueSet]

    A builder object for value sets

    A builder object for value sets

    Definition Classes
    ValueSet → SpecificIterableFactory → Factory
  7. implicit def specificIterableFactory: Factory[Value, ValueSet]
    Definition Classes
    SpecificIterableFactory