scala.util.Either.RightBias.withEmptyToken

AbstractOps

Related Doc: package withEmptyToken

abstract class AbstractOps[A, B] extends AnyRef

Implements the operations of a right-biased Either, whose specific behavior -- especially with respect to handling of an empty value resulting from a filter or failed pattern match -- is defined by constructor argument opsTypeClass.

Clients can extend this is they wish to defined specialized right-biased Either instances that define extra operations.

val EmptyThrowable = {
  // the stack-trace on construction has no relevance to operations that return this token
  // so we clear that stack trace
  val tmp = new NoSuchElementException("EMPTY -- A value was right empty after a failed filter or pattern match operation.");
  tmp.setStackTrace( Array.empty[StackTraceElement] );
  tmp
}
val RightBias = Either.RightBias.withEmptyToken[Throwable]( EmptyThrowable );
implicit class RightBiasOps[B]( target : Either[Throwable,B] ) extends Either.RightBias.withEmptyToken.AbstractOps( target )( RightBias ) {
   def raise : Unit = {
     target match {
       case Left( t ) => throw t;
       case Right( _ ) => ();
     }
   }
}

For more, see RightBias.

Source
Either.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AbstractOps
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractOps(target: Either[A, B])(opsTypeClass: Generic[A])

Value Members

  1. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from AbstractOps[A, B] to any2stringadd[AbstractOps[A, B]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AbstractOps[A, B], B)

    Implicit information
    This member is added by an implicit conversion from AbstractOps[A, B] to ArrowAssoc[AbstractOps[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    arg0

    the object to compare against this object for equality.

    returns

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

    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  7. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
    Note

    not specified by SLS as a member of AnyRef

  8. def conformsToBias: Boolean

    Returns true if this wrapper represents a left-biased Either wrapping a Left or a right-biased Either wrapping a Right.

    Returns true if this wrapper represents a left-biased Either wrapping a Left or a right-biased Either wrapping a Right. Returns false if the bias of this wrapper is not consistent with the type of the target Either.

    It is safe to call get on a biased Either for which conformsToBias is true.

    It is safe to call xget on a biased Either for which conformsToBias is false.

  9. def ensuring(cond: (AbstractOps[A, B]) ⇒ Boolean, msg: ⇒ Any): AbstractOps[A, B]

    Implicit information
    This member is added by an implicit conversion from AbstractOps[A, B] to Ensuring[AbstractOps[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (AbstractOps[A, B]) ⇒ Boolean): AbstractOps[A, B]

    Implicit information
    This member is added by an implicit conversion from AbstractOps[A, B] to Ensuring[AbstractOps[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): AbstractOps[A, B]

    Implicit information
    This member is added by an implicit conversion from AbstractOps[A, B] to Ensuring[AbstractOps[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): AbstractOps[A, B]

    Implicit information
    This member is added by an implicit conversion from AbstractOps[A, B] to Ensuring[AbstractOps[A, B]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

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

    Definition Classes
    AnyRef
  14. def equals(arg0: 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
    AnyRef → Any
  15. def exists(f: (B) ⇒ Boolean): Boolean

    Returns false if the target right-biased Either is a Left or returns the result of the application of the given function to the Right value.

    Returns false if the target right-biased Either is a Left or returns the result of the application of the given function to the Right value.

    Right(12).exists(_ > 10) // true
    Right(7).exists(_ > 10)  // false
    Left(12).exists(_ > 10)  // false
  16. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  17. def flatMap[AA >: A, Z](f: (B) ⇒ Either[AA, Z]): Either[AA, Z]

    Binds the given function across Right of athe target right-biased Either.

    Binds the given function across Right of athe target right-biased Either.

    Left(12).flatMap(x => Left("scala"))  // Left(12)
    Right(12).flatMap(x => Right("scala") // Right("scala")
    f

    The function to bind across Left.

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

    Returns true if the target right-biased Either is Left or returns the result of the application of the given function to the Right value.

    Returns true if the target right-biased Either is Left or returns the result of the application of the given function to the Right value.

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

    Executes the given side-effecting function if the target right-biased Either is a Right.

    Executes the given side-effecting function if the target right-biased Either is a Right.

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

    The side-effecting function to execute.

  20. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from AbstractOps[A, B] to StringFormat[AbstractOps[A, B]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  21. def get: B

    Returns the value if the target right-biased Either is a Right or throws java.util.NoSuchElementException if the target is a Left.

    Returns the value if the target right-biased Either is a Right or throws java.util.NoSuchElementException if the target is a Left.

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

    java.util.NoSuchElementException if the target is scala.util.Left

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

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  23. def getOrElse[BB >: B](or: ⇒ BB): BB

    Returns the value from the target right-biased Either if it is a Right, or the argument or if it is a Left.

    Returns the value from the target right-biased Either if it is a Right, or the argument or if it is a Left.

    Left(12).getOrElse(17)  // 12
    Right(12).getOrElse(17) // 17
  24. 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
    AnyRef → Any
  25. def isEmpty: Boolean

    Returns true if this right-biased Either is a Left that contains the empty token, signifying empty.

    Returns true if this right-biased Either is a Left that contains the empty token, signifying empty. Returns false for any other error or value.

  26. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  27. def isLeftBiased: Boolean

    Returns true when called on a wrapper representing a left-biased Either, false otherwise.

  28. def isRightBiased: Boolean

    Returns true when called on a wrapper representing a right-biased Either, false otherwise.

  29. def map[Z](f: (B) ⇒ Z): Either[A, Z]

    Maps the function argument through Right of the target right-biased Either.

    Maps the function argument through Right of the target right-biased Either.

    Left(12).map(_ + 2)  // Left(12)
    Right(12).map(_ + 2) // Right(14)
  30. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  32. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  33. def replaceIfEmpty[AA >: A](replacement: ⇒ AA): Either[AA, B]

    If the target right-biased Either is a Left containing the empty token, returns a Left containing replacement.

    If the target right-biased Either is a Left containing the empty token, returns a Left containing replacement. Otherwise returns the target Either unchanged.

    // with empty token Int -1
    
    Left(12).replaceIfEmpty(99)  // Left(12)
    Left(-1).replaceIfEmpty(99)  // Left(99)
    Right(12).replaceIfEmpty(99) // Right(12)
    Right(-1).replaceIfEmpty(99) // Right(-1)
  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  35. def toOption: Option[B]

    Returns a Some containing the Right value of the target right-biased Either if it exists or a None if the target is a Left.

    Returns a Some containing the Right value of the target right-biased Either if it exists or a None if the target is a Left.

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

    Returns a Seq containing the Right value if it exists or an empty Seq if the target right-biased Either is a Left.

    Returns a Seq containing the Right value if it exists or an empty Seq if the target right-biased Either is a Left.

    Left(12).toSeq  // Seq()
    Right(12).toSeq // Seq(12)
  37. 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
    AnyRef → Any
  38. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def withFilter(p: (B) ⇒ Boolean): Either[A, B]

    Returns the target right-biased Either unchanged if it is a Right and the predicate p holds for its value, or if it is any Left.

    Returns the target right-biased Either unchanged if it is a Right and the predicate p holds for its value, or if it is any Left.

    Returns a Left containing the empty token if the target is a Right but predicate p fails to hold. If no empty token has been set, a java.util.NoSuchElementException will be thrown.

    val RightBias = RightBias.withEmptyToken[Int](-1);
    import RightBias._
    
    Left(7).withFilter(_ > 10)   // Left(7)
    Right(7).withFilter(_ > 10)  // Left(-1)
    Right(12).withFilter(_ > 10) // Right(12)
  42. def xget: A

    "cross-get" -- Returns the value if the target right-biased Either does not conform to its bias, that is, if it is a Left.

    "cross-get" -- Returns the value if the target right-biased Either does not conform to its bias, that is, if it is a Left. Throws java.util.NoSuchElementException if the target is a Right.

    Left(12).xget  // 12
    Right(12).xget // NoSuchElementException
    Exceptions thrown

    java.util.NoSuchElementException if the target is scala.util.Right

  43. def xgetOrElse[AA >: A](or: ⇒ AA): AA

    "cross-getOrElse" -- Returns the value from the target right-biased Either if it does not conform to its bias and is a Left.

    "cross-getOrElse" -- Returns the value from the target right-biased Either if it does not conform to its bias and is a Left. Returns the argument or if it is a Right.

    Right(12).xgetOrElse(17) // 17
    Left(12).xgetOrElse(17)  // 12
  44. def xmap[Z](f: (A) ⇒ Z): Either[Z, B]

    "cross-map" -- Maps the function argument through Left against the bias the target right-biased Either.

    "cross-map" -- Maps the function argument through Left against the bias the target right-biased Either.

    Left(12).map(_ + 2)  // Left(14)
    Right(12).map(_ + 2) // Right(12)
  45. def [B](y: B): (AbstractOps[A, B], B)

    Implicit information
    This member is added by an implicit conversion from AbstractOps[A, B] to ArrowAssoc[AbstractOps[A, B]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AbstractOps[A, B] to any2stringadd[AbstractOps[A, B]]

Inherited by implicit conversion StringFormat from AbstractOps[A, B] to StringFormat[AbstractOps[A, B]]

Inherited by implicit conversion Ensuring from AbstractOps[A, B] to Ensuring[AbstractOps[A, B]]

Inherited by implicit conversion ArrowAssoc from AbstractOps[A, B] to ArrowAssoc[AbstractOps[A, B]]

Ungrouped