Packages

  • package root
    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package scalatest

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    ScalaTest's main traits, classes, and other members, including members supporting ScalaTest's DSL for the Scala interpreter.

    Definition Classes
    org
  • trait EitherValues extends Serializable

    Trait that provides an implicit conversion that adds value (when you expect a Right) and left.value (when you expect a Left) methods to Either, which will return the selected value of the Either if defined, or throw TestFailedException if not.

    Trait that provides an implicit conversion that adds value (when you expect a Right) and left.value (when you expect a Left) methods to Either, which will return the selected value of the Either if defined, or throw TestFailedException if not.

    This construct allows you to express in one statement that an Either should be left or right and that its value should meet some expectation. Here's are some examples:

    either1.value should be > 9
    either2.left.value should be ("Muchos problemas")
    

    Or, using assertions instead of matcher expressions:

    assert(either1.value > 9)
    assert(either2.left.value === "Muchos problemas")
    

    Were you to simply invoke left.get on the Either, if the Either wasn't defined as expected (e.g., it was a Right when you expected a Left), it would throw a NoSuchElementException:

    val either: Either[String, Int] = Right(9)
    
    either.left.get should be > "Muchos problemas" // either.right.get throws NoSuchElementException

    The NoSuchElementException would cause the test to fail, but without providing a stack depth pointing to the failing line of test code. This stack depth, provided by TestFailedException (and a few other ScalaTest exceptions), makes it quicker for users to navigate to the cause of the failure. Without EitherValues, to get a stack depth exception you would need to make two statements, like this:

    val either: Either[String, Int] = Right(9)
    
    either should be ('left) // throws TestFailedException either.left.get should be > "Muchos problemas"

    The EitherValues trait allows you to state that more concisely:

    val either: Either[String, Int] = Left("Muchas problemas")
    
    either.left.value should be > 9 // either.left.value throws TestFailedException

    Definition Classes
    scalatest
  • LeftValuable
  • RightValuable
  • Valuable

class LeftValuable[L, R] extends Serializable

Wrapper class that adds a value method to LeftProjection, allowing you to make statements like:

either.left.value should be > 9

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

Instance Constructors

  1. new LeftValuable(leftProj: LeftProjection[L, R], pos: Position)

    leftProj

    A LeftProjection to convert to LeftValuable, which provides the value method.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. def value: L

    Returns the Left value contained in the wrapped LeftProjection, if defined as a Left, else throws TestFailedException with a detail message indicating the Either was defined as a Right, not a Left.

  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped