Scaladoc for scala.Left

Inherited

Hide All
Show all

Product
Equals
Either
AnyRef
Any

Visibility

Public
All

Instance constructors

new Left(a: A)

Value Members

def !=(arg0: AnyRef): Boolean

attributes: final
definition classes: AnyRef
def !=(arg0: Any): Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ##(): Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf[T0](): T0

attributes: final
definition classes: AnyRef
def $isInstanceOf[T0](): Boolean

attributes: final
definition classes: AnyRef
def ==(arg0: AnyRef): Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def ==(arg0: Any): Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
val a: A
def asInstanceOf[T0]: T0

This method is used to cast the receiver object to be of type T0.

This method is used to 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 expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(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 typed.
returns
the receiver object.
attributes: final
definition classes: Any
def canEqual(arg0: Any): Boolean

A method that should be called from every well-designed equals method that is open to be overridden in a subclass.

A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.
definition classes: Left → Equals
def clone(): AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns 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
definition classes: AnyRef
def eq(arg0: AnyRef): Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other 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).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals(arg0: Any): Boolean

The equality method defined in AnyRef.

The equality method defined in AnyRef.@return true if the receiver object is equivalent to the argument; false otherwise. */
definition classes: Left → Equals → AnyRef → Any
def finalize(): Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def fold[X](fa: (A) ⇒ X, fb: (B) ⇒ X): X

Deconstruction of the Either type (in contrast to pattern matching).

Deconstruction of the Either type (in contrast to pattern matching).
definition classes: Either
def getClass(): java.lang.Class[_ <: java.lang.Object]

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

Returns 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.
attributes: final
definition classes: AnyRef
def hashCode(): Int

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object.
definition classes: Left → AnyRef → Any
def isInstanceOf[T0]: Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.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 requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def isLeft: Boolean

Returns true if this is a Left, false otherwise.

Returns true if this is a Left, false otherwise.
definition classes: Left → Either
def isRight: Boolean

Returns true if this is a Right, false otherwise.

Returns true if this is a Right, false otherwise.
definition classes: Left → Either
def joinLeft[A1 >: A, B1 >: B, C](implicit ev: <:<[A1, Either[C, B1]]): Either[C, B1]

Joins an Either through Left.

Joins an Either through Left.
definition classes: Either
def joinRight[A1 >: A, B1 >: B, C](implicit ev: <:<[B1, Either[A1, C]]): Either[A1, C]

Joins an Either through Right.

Joins an Either through Right.
definition classes: Either
def left: LeftProjection[A, B]

Projects this Either as a Left.

Projects this Either as a Left.
definition classes: Either
def ne(arg0: AnyRef): Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
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.
attributes: final
definition classes: AnyRef
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.
attributes: final
definition classes: AnyRef
def productArity: Int

return k for a product A(x_1,.
return k for a product A(x_1,...,x_k) definition classes: Left → Product
def productElement(arg0: Int): Any For a product A(x_1,. For a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k returns The element n elements after the first element definition classes: Left → Product
def productElements: Iterator[Any] definition classes: Product deprecated: use productIterator instead
def productIterator: Iterator[Any] An iterator that returns all fields of this product An iterator that returns all fields of this product definition classes: Product
def productPrefix: String By default the empty string. By default the empty string. Implementations may override this method in order to prepend a string prefix to the result of the toString methods. definition classes: Left → Product
def right: RightProjection[A, B] Projects this Either as a Right. Projects this Either as a Right. definition classes: Either
def swap: Product with Either[B, A] If this is a Left, then return the left value in Right or vice versa. If this is a Left, then return the left value in Right or vice versa. definition classes: Either
def synchronized[T0](arg0: T0): T0 attributes: final definition classes: AnyRef
def toString(): String Returns a string representation of the object. Returns a string representation of the object. The default representation is platform dependent. returns a string representation of the object. definition classes: Left → AnyRef → Any
def wait(): Unit attributes: final definition classes: AnyRef
def wait(arg0: Long, arg1: Int): Unit attributes: final definition classes: AnyRef
def wait(arg0: Long): Unit attributes: final definition classes: AnyRef

Left

class Left[+A, +B](a: A) extends Either[A, B] with Product

Instance constructors

new Left(a: A)

Value Members

def !=(arg0: AnyRef): Boolean

def !=(arg0: Any): Boolean

def ##(): Int

def $asInstanceOf[T0](): T0

def $isInstanceOf[T0](): Boolean

def ==(arg0: AnyRef): Boolean

def ==(arg0: Any): Boolean

val a: A

def asInstanceOf[T0]: T0

def canEqual(arg0: Any): Boolean

def clone(): AnyRef

def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fold[X](fa: (A) ⇒ X, fb: (B) ⇒ X): X

def getClass(): java.lang.Class[_ <: java.lang.Object]

def hashCode(): Int

def isInstanceOf[T0]: Boolean

def isLeft: Boolean

def isRight: Boolean

def joinLeft[A1 >: A, B1 >: B, C](implicit ev: <:<[A1, Either[C, B1]]): Either[C, B1]

def joinRight[A1 >: A, B1 >: B, C](implicit ev: <:<[B1, Either[A1, C]]): Either[A1, C]

def left: LeftProjection[A, B]

def ne(arg0: AnyRef): Boolean

def notify(): Unit

def notifyAll(): Unit

def productArity: Int

def productElement(arg0: Int): Any

def productElements: Iterator[Any]

def productIterator: Iterator[Any]

def productPrefix: String

def right: RightProjection[A, B]

def swap: Product with Either[B, A]

def synchronized[T0](arg0: T0): T0

def toString(): String

def wait(): Unit

def wait(arg0: Long, arg1: Int): Unit

def wait(arg0: Long): Unit