Class

scala.util.Either

RightProjection

Related Doc: package Either

Permalink

final case class RightProjection[+A, +B](e: Either[A, B]) extends Product with Serializable

Projects an Either into a Right.

This allows for-comprehensions over Either instances - for example

for (s <- Right("flower").right) yield s.length // Right(6)

Continuing the analogy with scala.Option, a RightProjection declares that Right should be analogous to Some in some code.

Analogous to LeftProjection, see example usage in its documentation above.

Version

1.0, 11/10/2008

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RightProjection
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RightProjection(e: Either[A, B])

    Permalink

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val e: Either[A, B]

    Permalink
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def exists(p: (B) ⇒ Boolean): Boolean

    Permalink

    Returns false if Left or returns the result of the application of the given function to the Right value.

    Returns false if Left or returns the result of the application of the given function to the Right value.

    Right(12).right.exists(_ > 10)  // true
    Right(7).right.exists(_ > 10)   // false
    Left(12).right.exists(_ > 10)   // false
  9. def filter[X](p: (B) ⇒ Boolean): Option[Either[X, B]]

    Permalink

    Returns None if this is a Left or if the given predicate p does not hold for the right value, otherwise, returns a Right.

    Returns None if this is a Left or if the given predicate p does not hold for the right value, otherwise, returns a Right.

    Right(12).right.filter(_ > 10) // Some(Right(12))
    Right(7).right.filter(_ > 10)  // None
    Left(12).right.filter(_ > 10)  // None
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def flatMap[AA >: A, Y](f: (B) ⇒ Either[AA, Y]): Either[AA, Y]

    Permalink

    Binds the given function across Right.

    Binds the given function across Right.

    f

    The function to bind across Right.

  12. def forall(f: (B) ⇒ Boolean): Boolean

    Permalink

    Returns true if Left or returns the result of the application of the given function to the Right value.

    Returns true if Left or returns the result of the application of the given function to the Right value.

    Right(12).right.forall(_ > 10) // true
    Right(7).right.forall(_ > 10)  // false
    Left(12).right.forall(_ > 10)  // true
  13. def foreach[U](f: (B) ⇒ U): Any

    Permalink

    Executes the given side-effecting function if this is a Right.

    Executes the given side-effecting function if this is a Right.

    Right(12).right.foreach(x => println(x)) // prints "12"
    Left(12).right.foreach(x => println(x))  // doesn't print
    f

    The side-effecting function to execute.

  14. def get: B

    Permalink

    Returns the value from this Right or throws java.util.NoSuchElementException if this is a Left.

    Returns the value from this Right or throws java.util.NoSuchElementException if this is a Left.

    Right(12).right.get // 12
    Left(12).right.get // NoSuchElementException
    Exceptions thrown

    java.util.NoSuchElementException if the projection is Left.

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def getOrElse[BB >: B](or: ⇒ BB): BB

    Permalink

    Returns the value from this Right or the given argument if this is a Left.

    Returns the value from this Right or the given argument if this is a Left.

    Right(12).right.getOrElse(17) // 12
    Left(12).right.getOrElse(17)  // 17
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def map[Y](f: (B) ⇒ Y): Product with Serializable with Either[A, Y]

    Permalink

    The given function is applied if this is a Right.

    The given function is applied if this is a Right.

    Right(12).right.map(x => "flower") // Result: Right("flower")
    Left(12).right.map(x => "flower")  // Result: Left(12)
  19. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  23. def toOption: Option[B]

    Permalink

    Returns a Some containing the Right value if it exists or a None if this is a Left.

    Returns a Some containing the Right value if it exists or a None if this is a Left.

    Right(12).right.toOption // Some(12)
    Left(12).right.toOption // None
  24. def toSeq: collection.Seq[B]

    Permalink

    Returns a Seq containing the Right value if it exists or an empty Seq if this is a Left.

    Returns a Seq containing the Right value if it exists or an empty Seq if this is a Left.

    Right(12).right.toSeq // Seq(12)
    Left(12).right.toSeq // Seq()
  25. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped