Object/Class

org.scalatest.time

Span

Related Docs: class Span | package time

Permalink

object Span extends Serializable

Companion object for Span that provides two factory methods for creating Span instances.

The first argument to each factory method is a numeric value; the second argument is a Units value. One factory method takes a Long, so it can be invoked with either an Int or Long, as in:

import org.scalatest.time._

Span(1, Second)
Span(1L, Millisecond)

The other factory method takes a Double, so it can be invoked with either a Float or a Double:

import org.scalatest.time._

Span(2.5F, Seconds)
Span(99.9, Microseconds)

Source
Span.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Span
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. val Max: Span

    Permalink

    A Span with the maximum expressible value, Span(Long.MaxValue, Nanoseconds), which is approximately 292 years.

    A Span with the maximum expressible value, Span(Long.MaxValue, Nanoseconds), which is approximately 292 years.

    One use case for this Span value is to help convert a duration concept from a different library to Span when that library's duration concept includes a notion of infinite durations. An infinite duration can be converted to Span.Max.

    returns

    a Span with the maximum expressible value, Long.MaxValue nanoseconds.

  5. val Zero: Span

    Permalink

    A Span with representing a zero-length span of time.

    A Span with representing a zero-length span of time.

    returns

    a zero-length Span.

  6. def apply(length: Double, units: Units): Span

    Permalink

    Returns a Span representing the passed Double length of time in the passed units.

    Returns a Span representing the passed Double length of time in the passed units.

    If the requested time span is less than 0.0 or, when converted to Long number of nanoseconds, would be greater than Long.MaxValue nanoseconds, this method will throw an IllegalArgumentException. (Note: a zero-length time span is allowed, just not a negative or too-large time span.)

    length

    the length of time denominated by the passed units

    units

    the units of time for the passed length

    returns

    a Span representing the requested time span

    Exceptions thrown

    IllegalArgumentException if the requested time span, when converted to Long number of nanoseconds, would be greater than Long.MaxValue nanoseconds, the maximum time span expressible with a Span

  7. def apply(length: Long, units: Units): Span

    Permalink

    Returns a Span representing the passed Long length of time in the passed units.

    Returns a Span representing the passed Long length of time in the passed units.

    If the requested time span is less than zero or greater than Long.MaxValue nanoseconds, this method will throw an IllegalArgumentException. (Note: a zero-length time span is allowed, just not a negative or too-large time span.)

    length

    the length of time denominated by the passed units

    units

    the units of time for the passed length

    returns

    a Span representing the requested time span

    Exceptions thrown

    IllegalArgumentException if the requested time span is greater than Long.MaxValue nanoseconds, the maximum time span expressible with a Span

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. implicit def convertDurationToSpan(duration: Duration): Span

    Permalink

    Implicitly converts a scala.concurrent.duration.Duration to a Span, so that a Duration can be used where a Span is needed.

    Implicitly converts a scala.concurrent.duration.Duration to a Span, so that a Duration can be used where a Span is needed.

    This function transforms Duration.MinusInf to Span.Zero, Duration.Inf and Undefined to Span.Max, and all others to a Span containing a corresponing number of nanoseconds.

  11. implicit def convertSpanToDuration(span: Span): FiniteDuration

    Permalink

    Implicitly converts a Span to a scala.concurrent.duration.FiniteDuration, so that a Span can be used where a FiniteDuration is needed.

    Implicitly converts a Span to a scala.concurrent.duration.FiniteDuration, so that a Span can be used where a FiniteDuration is needed.

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped