scala

class Some

[source: scala/Some.scala]

case final class Some[+A](val x : A)
extends Option[A]
Class Some[A] represents existing values of type A.
Author
Martin Odersky
Version
1.0, 16/07/2003
Method Summary
override 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. See Programming in Scala, Chapter 28 for discussion and design.
override def equals (arg0 : Any) : Boolean
The equality method defined in `AnyRef`.
def get : A
get the value of this option. @requires that the option is nonEmpty.
override def hashCode : Int
Returns a hash code value for the object.
def isEmpty : Boolean
True if the option is the None value, false otherwise.
override def productArity : Int
return k for a product A(x_1,...,x_k)
override def productElement (arg0 : Int) : Any
for a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k
override def productPrefix : java.lang.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.
override def toString : java.lang.String
Returns a string representation of the object.
Methods inherited from Option
isDefined, getOrElse, orNull, map, flatMap, filter, exists, foreach, partialMap, orElse, iterator, toList, toRight, toLeft
Methods inherited from Product
productIterator, productElements
Methods inherited from AnyRef
getClass, clone, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Method Details
def isEmpty : Boolean
True if the option is the None value, false otherwise.
Overrides
Option.isEmpty

def get : A
get the value of this option. @requires that the option is nonEmpty.
Throws
Predef.NoSuchElementException - if the option is empty.
Overrides
Option.get

override def hashCode : Int
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.


override def toString : java.lang.String
Returns a string representation of the object.

The default representation is platform dependent.

Returns
a string representation of the object.


override def equals(arg0 : Any) : Boolean
The equality method defined in `AnyRef`.

override def productPrefix : java.lang.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.

override def productArity : Int
return k for a product A(x_1,...,x_k)

override def productElement(arg0 : Int) : Any
for a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k
Parameters
n - the index of the element to return
Throws
IndexOutOfBoundsException -
Returns
The element n elements after the first element

override 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. See Programming in Scala, Chapter 28 for discussion and design.