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
  • package concurrent

    This package object contains primitives for concurrent and parallel programming.

    This package object contains primitives for concurrent and parallel programming.

    Guide

    A more detailed guide to Futures and Promises, including discussion and examples can be found at http://docs.scala-lang.org/overviews/core/futures.html.

    Common Imports

    When working with Futures, you will often find that importing the whole concurrent package is convenient:

    import scala.concurrent._

    When using things like Futures, it is often required to have an implicit ExecutionContext in scope. The general advice for these implicits are as follows.

    If the code in question is a class or method definition, and no ExecutionContext is available, request one from the caller by adding an implicit parameter list:

    def myMethod(myParam: MyType)(implicit ec: ExecutionContext) = …
    //Or
    class MyClass(myParam: MyType)(implicit ec: ExecutionContext) { … }

    This allows the caller of the method, or creator of the instance of the class, to decide which ExecutionContext should be used.

    For typical REPL usage and experimentation, importing the global ExecutionContext is often desired.

    import scala.concurrent.ExcutionContext.Implicits.global

    Specifying Durations

    Operations often require a duration to be specified. A duration DSL is available to make defining these easier:

    import scala.concurrent.duration._
    val d: Duration = 10.seconds

    Using Futures For Non-blocking Computation

    Basic use of futures is easy with the factory method on Future, which executes a provided function asynchronously, handing you back a future result of that function without blocking the current thread. In order to create the Future you will need either an implicit or explicit ExecutionContext to be provided:

    import scala.concurrent._
    import ExecutionContext.Implicits.global  // implicit execution context
    
    val firstZebra: Future[Int] = Future {
      val words = Files.readAllLines("/etc/dictionaries-common/words").asScala
      words.indexOfSlice("zebra")
    }

    Avoid Blocking

    Although blocking is possible in order to await results (with a mandatory timeout duration):

    import scala.concurrent.duration._
    Await.result(firstZebra, 10.seconds)

    and although this is sometimes necessary to do, in particular for testing purposes, blocking in general is discouraged when working with Futures and concurrency in order to avoid potential deadlocks and improve performance. Instead, use callbacks or combinators to remain in the future domain:

    val animalRange: Future[Int] = for {
      aardvark <- firstAardvark
      zebra <- firstZebra
    } yield zebra - aardvark
    
    animalRange.onSuccess {
      case x if x > 500000 => println("It's a long way from Aardvark to Zebra")
    }
    Definition Classes
    scala
  • package duration
    Definition Classes
    concurrent
  • Deadline
  • DoubleMult
  • Duration
  • DurationConversions
  • DurationDouble
  • DurationInt
  • DurationLong
  • FiniteDuration
  • IntMult
  • LongMult
  • fromNow
  • span

final class FiniteDuration extends Duration

This class represents a finite duration. Its addition and subtraction operators are overloaded to retain this guarantee statically. The range of this class is limited to +-(2^63-1)ns, which is roughly 292 years.

Source
Duration.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FiniteDuration
  2. Duration
  3. Ordered
  4. Comparable
  5. Serializable
  6. AnyRef
  7. Any
Implicitly
  1. by orderingToOrdered
  2. by durationToPair
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FiniteDuration(length: Long, unit: TimeUnit)

Value Members

  1. def *(factor: Long): FiniteDuration

    Return the product of this duration and the given integer factor.

    Return the product of this duration and the given integer factor.

    Exceptions thrown

    IllegalArgumentException if the result would overflow the range of FiniteDuration

  2. def *(factor: Double): Duration

    Return this duration multiplied by the scalar factor.

    Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  3. def +(other: FiniteDuration): FiniteDuration
  4. def +(other: Duration): Duration

    Return the sum of that duration and this.

    Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  5. def -(other: FiniteDuration): FiniteDuration
  6. def -(other: Duration): Duration

    Return the difference of that duration and this.

    Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  7. def /(divisor: Long): FiniteDuration

    Return the quotient of this duration and the given integer factor.

    Return the quotient of this duration and the given integer factor.

    Exceptions thrown

    java.lang.ArithmeticException if the factor is 0

  8. def /(divisor: Duration): Double

    Return the quotient of this and that duration as floating-point number.

    Return the quotient of this and that duration as floating-point number. The semantics are determined by Double as if calculating the quotient of the nanosecond lengths of both factors.

    Definition Classes
    FiniteDurationDuration
  9. def /(divisor: Double): Duration

    Return this duration divided by the scalar factor.

    Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  10. def <(that: Duration): Boolean

    Returns true if this is less than that

    Returns true if this is less than that

    Definition Classes
    Ordered
  11. def <=(that: Duration): Boolean

    Returns true if this is less than or equal to that.

    Returns true if this is less than or equal to that.

    Definition Classes
    Ordered
  12. def >(that: Duration): Boolean

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Definition Classes
    Ordered
  13. def >=(that: Duration): Boolean

    Returns true if this is greater than or equal to that.

    Returns true if this is greater than or equal to that.

    Definition Classes
    Ordered
  14. def compare(other: Duration): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Implement this method to determine how instances of A will be sorted.

    Returns x where:

    • x < 0 when this < that
    • x == 0 when this == that
    • x > 0 when this > that
    Definition Classes
    FiniteDurationOrdered
  15. def compareTo(that: Duration): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Definition Classes
    Ordered → Comparable
  16. def div(divisor: Long): FiniteDuration

    Return the quotient of this duration and the given integer factor.

    Return the quotient of this duration and the given integer factor.

    Exceptions thrown

    java.lang.ArithmeticException if the factor is 0

  17. def div(other: Duration): Double

    Return the quotient of this and that duration as floating-point number.

    Return the quotient of this and that duration as floating-point number. The semantics are determined by Double as if calculating the quotient of the nanosecond lengths of both factors.

    Definition Classes
    Duration
  18. def div(divisor: Double): Duration

    Return this duration divided by the scalar factor.

    Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.

    Definition Classes
    Duration
    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  19. def equals(other: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    FiniteDuration → AnyRef → Any
  20. def fromNow: Deadline

    Construct a Deadline from this duration by adding it to the current instant Deadline.now.

  21. def gt(other: Duration): Boolean
    Definition Classes
    Duration
  22. def gteq(other: Duration): Boolean
    Definition Classes
    Duration
  23. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    FiniteDuration → AnyRef → Any
  24. final def isFinite: Boolean

    This method returns whether this duration is finite, which is not the same as !isInfinite for Double because this method also returns false for Duration.Undefined.

    This method returns whether this duration is finite, which is not the same as !isInfinite for Double because this method also returns false for Duration.Undefined.

    Definition Classes
    FiniteDurationDuration
  25. val length: Long

    Obtain the length of this Duration measured in the unit obtained by the unit method.

    Obtain the length of this Duration measured in the unit obtained by the unit method.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  26. def lt(other: Duration): Boolean
    Definition Classes
    Duration
  27. def lteq(other: Duration): Boolean
    Definition Classes
    Duration
  28. def max(other: FiniteDuration): FiniteDuration
  29. def max(other: Duration): Duration

    Return the larger of this and that duration as determined by the natural ordering.

    Return the larger of this and that duration as determined by the natural ordering.

    Definition Classes
    Duration
  30. def min(other: FiniteDuration): FiniteDuration
  31. def min(other: Duration): Duration

    Return the smaller of this and that duration as determined by the natural ordering.

    Return the smaller of this and that duration as determined by the natural ordering.

    Definition Classes
    Duration
  32. def minus(other: FiniteDuration): FiniteDuration
  33. def minus(other: Duration): Duration

    Return the difference of that duration and this.

    Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.

    Definition Classes
    Duration
    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  34. def mul(factor: Long): FiniteDuration

    Return the product of this duration and the given integer factor.

    Return the product of this duration and the given integer factor.

    Exceptions thrown

    IllegalArgumentException if the result would overflow the range of FiniteDuration

  35. def mul(factor: Double): Duration

    Return this duration multiplied by the scalar factor.

    Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.

    Definition Classes
    Duration
    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  36. def neg(): Duration

    Negate this duration.

    Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.

    Definition Classes
    Duration
  37. def plus(other: FiniteDuration): FiniteDuration
  38. def plus(other: Duration): Duration

    Return the sum of that duration and this.

    Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.

    Definition Classes
    Duration
    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  39. def productArity: Int

    The arity of this product.

    The arity of this product.

    returns

    2

    Implicit
    This member is added by an implicit conversion from FiniteDuration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
    Definition Classes
    Product2Product
  40. def productElement(n: Int): Any

    Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an IndexOutOfBoundsException.

    Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an IndexOutOfBoundsException.

    n

    number of the projection to be returned

    returns

    same as ._(n+1), for example productElement(0) is the same as ._1.

    Implicit
    This member is added by an implicit conversion from FiniteDuration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
    Definition Classes
    Product2Product
    Annotations
    @throws(clazz = classOf[IndexOutOfBoundsException])
    Exceptions thrown

    IndexOutOfBoundsException if the n is out of range(n < 0 || n >= 2).

  41. def productElementNames: Iterator[String]

    An iterator over the names of all the elements of this product.

    An iterator over the names of all the elements of this product.

    Implicit
    This member is added by an implicit conversion from FiniteDuration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
    Definition Classes
    Product
  42. def swap: (TimeUnit, Long)

    Swaps the elements of this Tuple.

    Swaps the elements of this Tuple.

    returns

    a new Tuple where the first element is the second element of this Tuple and the second element is the first element of this Tuple.

    Implicit
    This member is added by an implicit conversion from FiniteDuration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
    Definition Classes
    Tuple2
  43. final def toCoarsest: FiniteDuration

    Return duration which is equal to this duration but with a coarsest Unit, or self in case it is already the coarsest Unit

    Return duration which is equal to this duration but with a coarsest Unit, or self in case it is already the coarsest Unit

    Examples:

    Duration(60, MINUTES).toCoarsest // Duration(1, HOURS)
    Duration(1000, MILLISECONDS).toCoarsest // Duration(1, SECONDS)
    Duration(48, HOURS).toCoarsest // Duration(2, DAYS)
    Duration(5, SECONDS).toCoarsest // Duration(5, SECONDS)
    Definition Classes
    FiniteDurationDuration
  44. def toDays: Long

    Return the length of this duration measured in whole days, rounding towards zero.

    Return the length of this duration measured in whole days, rounding towards zero.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  45. def toHours: Long

    Return the length of this duration measured in whole hours, rounding towards zero.

    Return the length of this duration measured in whole hours, rounding towards zero.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  46. def toMicros: Long

    Return the length of this duration measured in whole microseconds, rounding towards zero.

    Return the length of this duration measured in whole microseconds, rounding towards zero.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  47. def toMillis: Long

    Return the length of this duration measured in whole milliseconds, rounding towards zero.

    Return the length of this duration measured in whole milliseconds, rounding towards zero.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  48. def toMinutes: Long

    Return the length of this duration measured in whole minutes, rounding towards zero.

    Return the length of this duration measured in whole minutes, rounding towards zero.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  49. def toNanos: Long

    Return the length of this duration measured in whole nanoseconds, rounding towards zero.

    Return the length of this duration measured in whole nanoseconds, rounding towards zero.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  50. def toSeconds: Long

    Return the length of this duration measured in whole seconds, rounding towards zero.

    Return the length of this duration measured in whole seconds, rounding towards zero.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  51. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    FiniteDuration → AnyRef → Any
  52. def toUnit(u: TimeUnit): Double

    Return the number of nanoseconds as floating point number, scaled down to the given unit.

    Return the number of nanoseconds as floating point number, scaled down to the given unit. The result may not precisely represent this duration due to the Double datatype's inherent limitations (mantissa size effectively 53 bits). Non-finite durations are represented as

    Definition Classes
    FiniteDurationDuration
  53. def unary_-: FiniteDuration

    Negate this duration.

    Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.

    Definition Classes
    FiniteDurationDuration
  54. val unit: TimeUnit

    Obtain the time unit in which the length of this duration is measured.

    Obtain the time unit in which the length of this duration is measured.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

Shadowed Implicit Value Members

  1. def <(that: FiniteDuration): Boolean

    Returns true if this is less than that

    Returns true if this is less than that

    Implicit
    This member is added by an implicit conversion from FiniteDuration tomath.Ordered[FiniteDuration] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (finiteDuration: math.Ordered[FiniteDuration]).<(that)
    Definition Classes
    Ordered
  2. def <=(that: FiniteDuration): Boolean

    Returns true if this is less than or equal to that.

    Returns true if this is less than or equal to that.

    Implicit
    This member is added by an implicit conversion from FiniteDuration tomath.Ordered[FiniteDuration] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (finiteDuration: math.Ordered[FiniteDuration]).<=(that)
    Definition Classes
    Ordered
  3. def >(that: FiniteDuration): Boolean

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Implicit
    This member is added by an implicit conversion from FiniteDuration tomath.Ordered[FiniteDuration] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (finiteDuration: math.Ordered[FiniteDuration]).>(that)
    Definition Classes
    Ordered
  4. def >=(that: FiniteDuration): Boolean

    Returns true if this is greater than or equal to that.

    Returns true if this is greater than or equal to that.

    Implicit
    This member is added by an implicit conversion from FiniteDuration tomath.Ordered[FiniteDuration] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (finiteDuration: math.Ordered[FiniteDuration]).>=(that)
    Definition Classes
    Ordered
  5. def compare(that: FiniteDuration): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Implement this method to determine how instances of A will be sorted.

    Returns x where:

    • x < 0 when this < that
    • x == 0 when this == that
    • x > 0 when this > that
    Implicit
    This member is added by an implicit conversion from FiniteDuration tomath.Ordered[FiniteDuration] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (finiteDuration: math.Ordered[FiniteDuration]).compare(that)
    Definition Classes
    Ordered
  6. def compareTo(that: FiniteDuration): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Implicit
    This member is added by an implicit conversion from FiniteDuration tomath.Ordered[FiniteDuration] performed by method orderingToOrdered in scala.math.Ordered.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (finiteDuration: math.Ordered[FiniteDuration]).compareTo(that)
    Definition Classes
    Ordered → Comparable
  7. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Implicit
    This member is added by an implicit conversion from FiniteDuration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (finiteDuration: (Long, TimeUnit)).toString()
    Definition Classes
    Tuple2 → AnyRef → Any