Some
Class Some[A] represents existing values of type A.
Type parameters
- A
-
the type of the contained value
Value parameters
- value
-
the contained value
Attributes
- Source
- Option.scala
- Graph
-
- Supertypes
-
class Option[A]trait Serializabletrait Producttrait Equalstrait IterableOnce[A]class Objecttrait Matchableclass AnyShow all
Members list
Type members
Inherited classlikes
We need a whole WithFilter class to honor the "doesn't create a new collection" contract even though it seems unlikely to matter much in a collection with max size 1.
We need a whole WithFilter class to honor the "doesn't create a new collection" contract even though it seems unlikely to matter much in a collection with max size 1.
Value parameters
- p
-
the predicate used to filter the option value
Attributes
- Inherited from:
- Option
- Source
- Option.scala
- Supertypes
Value members
Concrete methods
Returns the option's value.
Returns the option's value.
This is equivalent to:
option match {
case Some(x) => x
case None => throw new Exception
}
Attributes
- Returns
-
the contained value
- Throws
-
NoSuchElementException
if the option is empty.
- Note
-
The option must be nonempty.
- Source
- Option.scala
Inherited methods
Returns a scala.Some containing the result of applying pf to this scala.Option's contained value, if this option is nonempty and pf is defined for that value. Returns None otherwise.
Returns a scala.Some containing the result of applying pf to this scala.Option's contained value, if this option is nonempty and pf is defined for that value. Returns None otherwise.
Type parameters
- B
-
the result type of the partial function
Value parameters
- pf
-
the partial function.
Attributes
- Returns
-
the result of applying
pfto this scala.Option's value (if possible), orNone. - Example
-
// Returns Some(HTTP) because the partial function covers the case. Some("http") collect {case "http" => "HTTP"} // Returns None because the partial function doesn't cover the case. Some("ftp") collect {case "http" => "HTTP"} // Returns None because the option is empty. There is no value to pass to the partial function. None collect {case value => value} - Inherited from:
- Option
- Source
- Option.scala
Tests whether the option contains a given value as an element.
Tests whether the option contains a given value as an element.
This is equivalent to:
option match {
case Some(x) => x == elem
case None => false
}
Type parameters
- A1
-
a supertype of
Aused for the equality comparison
Value parameters
- elem
-
the element to test.
Attributes
- Returns
-
trueif the option has an element that is equal (as determined by==) toelem,falseotherwise. - Example
-
// Returns true because Some instance contains string "something" which equals "something". Some("something") contains "something" // Returns false because "something" != "anything". Some("something") contains "anything" // Returns false when method called on None. None contains "anything" - Inherited from:
- Option
- Source
- Option.scala
Returns true if this option is nonempty and the predicate p returns true when applied to this scala.Option's value. Otherwise, returns false.
Returns true if this option is nonempty and the predicate p returns true when applied to this scala.Option's value. Otherwise, returns false.
This is equivalent to:
option match {
case Some(x) => p(x)
case None => false
}
Value parameters
- p
-
the predicate to test
Attributes
- Returns
-
trueif this option is nonempty andpreturns true when applied to the value,falseotherwise - Inherited from:
- Option
- Source
- Option.scala
Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns true. Otherwise, return None.
Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns true. Otherwise, return None.
This is equivalent to:
option match {
case Some(x) if p(x) => Some(x)
case _ => None
}
Value parameters
- p
-
the predicate used for testing.
Attributes
- Returns
-
this option if nonempty and the predicate returns true, otherwise
None - Inherited from:
- Option
- Source
- Option.scala
Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns false. Otherwise, return None.
Returns this scala.Option if it is nonempty and applying the predicate p to this scala.Option's value returns false. Otherwise, return None.
This is equivalent to:
option match {
case Some(x) if !p(x) => Some(x)
case _ => None
}
Value parameters
- p
-
the predicate used for testing.
Attributes
- Returns
-
this option if nonempty and the predicate returns false, otherwise
None - Inherited from:
- Option
- Source
- Option.scala
Returns the result of applying f to this scala.Option's value if this scala.Option is nonempty. Returns None if this scala.Option is empty. Slightly different from map in that f is expected to return an scala.Option (which could be None).
Returns the result of applying f to this scala.Option's value if this scala.Option is nonempty. Returns None if this scala.Option is empty. Slightly different from map in that f is expected to return an scala.Option (which could be None).
This is equivalent to:
option match {
case Some(x) => f(x)
case None => None
}
Type parameters
- B
-
the element type of the returned option
Value parameters
- f
-
the function to apply
Attributes
- Returns
-
the result of applying
fto this option's value if nonempty, otherwiseNone - See also
-
map
foreach
- Inherited from:
- Option
- Source
- Option.scala
Returns the nested scala.Option value if it is nonempty. Otherwise, return None.
Returns the nested scala.Option value if it is nonempty. Otherwise, return None.
This is equivalent to:
option match {
case Some(Some(b)) => Some(b)
case _ => None
}
Type parameters
- B
-
the element type of the nested option
Value parameters
- ev
-
an implicit conversion that asserts that the value is also an scala.Option.
Attributes
- Returns
-
the contained option if nonempty, otherwise
None - See also
-
flatMap
- Example
-
Some(Some("something")).flatten - Inherited from:
- Option
- Source
- Option.scala
Returns the result of applying f to this scala.Option's value if the scala.Option is nonempty. Otherwise, evaluates expression ifEmpty.
Returns the result of applying f to this scala.Option's value if the scala.Option is nonempty. Otherwise, evaluates expression ifEmpty.
This is equivalent to:
option match {
case Some(x) => f(x)
case None => ifEmpty
}
This is also equivalent to:
option.map(f).getOrElse(ifEmpty)
Type parameters
- B
-
the result type of the fold
Value parameters
- f
-
the function to apply if nonempty.
- ifEmpty
-
the expression to evaluate if empty.
Attributes
- Returns
-
the result of applying
fto this option's value if nonempty, otherwise the result of evaluatingifEmpty - Inherited from:
- Option
- Source
- Option.scala
Returns true if this option is empty or the predicate p returns true when applied to this scala.Option's value.
Returns true if this option is empty or the predicate p returns true when applied to this scala.Option's value.
This is equivalent to:
option match {
case Some(x) => p(x)
case None => true
}
Value parameters
- p
-
the predicate to test
Attributes
- Returns
-
trueif this option is empty or the predicate returns true when applied to the value - Inherited from:
- Option
- Source
- Option.scala
Applies the given procedure f to the option's value, if it is nonempty. Otherwise, do nothing.
Applies the given procedure f to the option's value, if it is nonempty. Otherwise, do nothing.
This is equivalent to:
option match {
case Some(x) => f(x)
case None => ()
}
Type parameters
- U
-
the result type of the procedure
f(result is discarded)
Value parameters
- f
-
the procedure to apply.
Attributes
- See also
-
map
flatMap
- Inherited from:
- Option
- Source
- Option.scala
Returns the option's value if the option is nonempty, otherwise return the result of evaluating default.
Returns the option's value if the option is nonempty, otherwise return the result of evaluating default.
This is equivalent to:
option match {
case Some(x) => x
case None => default
}
Type parameters
- B
-
the result type, a supertype of
A
Value parameters
- default
-
the default expression.
Attributes
- Returns
-
the option's value if nonempty, otherwise the result of evaluating
default - Inherited from:
- Option
- Source
- Option.scala
Returns true if the option is an instance of scala.Some, false otherwise.
Returns true if the option is an instance of scala.Some, false otherwise.
This is equivalent to:
option match {
case Some(_) => true
case None => false
}
Attributes
- Returns
-
trueif the option is aSome,falseotherwise - Inherited from:
- Option
- Source
- Option.scala
Returns true if the option is None, false otherwise.
Returns true if the option is None, false otherwise.
This is equivalent to:
option match {
case Some(_) => false
case None => true
}
Attributes
- Returns
-
trueif the option isNone,falseotherwise - Inherited from:
- Option
- Source
- Option.scala
Returns a singleton iterator returning the scala.Option's value if it is nonempty, or an empty iterator if the option is empty.
Returns a singleton iterator returning the scala.Option's value if it is nonempty, or an empty iterator if the option is empty.
Attributes
- Inherited from:
- Option
- Source
- Option.scala
The number of elements in this option, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
The number of elements in this option, if it can be cheaply computed, -1 otherwise. Cheaply usually means: Not requiring a collection traversal.
Attributes
- Definition Classes
- Inherited from:
- Option
- Source
- Option.scala
Returns a scala.Some containing the result of applying f to this scala.Option's value if this scala.Option is nonempty. Otherwise return None.
Returns a scala.Some containing the result of applying f to this scala.Option's value if this scala.Option is nonempty. Otherwise return None.
This is equivalent to:
option match {
case Some(x) => Some(f(x))
case None => None
}
Type parameters
- B
-
the result type of the function
f
Value parameters
- f
-
the function to apply
Attributes
- Returns
-
a
Somecontaining the result of applyingfto this option's value if nonempty, otherwiseNone - See also
-
flatMap
foreach
- Note
-
This is similar to
flatMapexcept here,fdoes not need to wrap its result in an scala.Option. - Inherited from:
- Option
- Source
- Option.scala
Returns false if the option is None, true otherwise.
Returns false if the option is None, true otherwise.
This is equivalent to:
option match {
case Some(_) => true
case None => false
}
Attributes
- Returns
-
trueif the option is aSome,falseotherwise - Note
-
Implemented here to avoid the implicit conversion to Iterable.
- Inherited from:
- Option
- Source
- Option.scala
Returns this scala.Option if it is nonempty, otherwise return the result of evaluating alternative.
Returns this scala.Option if it is nonempty, otherwise return the result of evaluating alternative.
This is equivalent to:
option match {
case Some(x) => Some(x)
case None => alternative
}
Type parameters
- B
-
the element type of the alternative option, a supertype of
A
Value parameters
- alternative
-
the alternative expression.
Attributes
- Returns
-
this option if nonempty, otherwise the result of evaluating
alternative - Inherited from:
- Option
- Source
- Option.scala
Returns the option's value if it is nonempty, or null if it is empty.
Returns the option's value if it is nonempty, or null if it is empty.
Although the use of null is discouraged, code written to use scala.Option must often interface with code that expects and returns nulls.
This is equivalent to:
option match {
case Some(x) => x
case None => null
}
Type parameters
- A1
-
a supertype of
Afor whichNullis a valid value
Value parameters
- ev
-
evidence that
Nullis a subtype ofA1
Attributes
- Returns
-
the option's value if nonempty, or
nullif empty - Example
-
val initialText: Option[String] = getInitialText val textField = new JComponent(initialText.orNull,20) - Inherited from:
- Option
- Source
- Option.scala
An iterator over the names of all the elements of this product.
An iterator over the names of all the elements of this product.
Attributes
- Inherited from:
- Product
- Source
- Product.scala
An iterator over all the elements of this product.
An iterator over all the elements of this product.
Attributes
- Returns
-
in the default implementation, an
Iterator[Any] - Inherited from:
- Product
- Source
- Product.scala
Returns a scala.collection.Stepper for the elements of this collection.
Returns a scala.collection.Stepper for the elements of this collection.
The Stepper enables creating a Java stream to operate on the collection, see scala.jdk.StreamConverters. For collections holding primitive values, the Stepper can be used as an iterator which doesn't box the elements.
The implicit scala.collection.StepperShape parameter defines the resulting Stepper type according to the element type of this collection.
- For collections of
Int,Short,ByteorChar, an scala.collection.IntStepper is returned - For collections of
DoubleorFloat, a scala.collection.DoubleStepper is returned - For collections of
Longa scala.collection.LongStepper is returned - For any other element type, an scala.collection.AnyStepper is returned
Note that this method is overridden in subclasses and the return type is refined to S with EfficientSplit, for example scala.collection.IndexedSeqOps.stepper. For Steppers marked with scala.collection.Stepper.EfficientSplit, the converters in scala.jdk.StreamConverters allow creating parallel streams, whereas bare Steppers can be converted only to sequential streams.
Type parameters
- S
-
the type of the returned
Stepper, determined by the implicitStepperShape
Attributes
- Inherited from:
- IterableOnce
- Source
- IterableOnce.scala
Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this scala.Option's value if this scala.Option is nonempty.
Returns a scala.util.Right containing the given argument right if this is empty, or a scala.util.Left containing this scala.Option's value if this scala.Option is nonempty.
This is equivalent to:
option match {
case Some(x) => Left(x)
case None => Right(right)
}
Type parameters
- X
-
the type of the
Rightvalue
Value parameters
- right
-
the expression to evaluate and return if this is empty
Attributes
- Returns
-
a
Leftcontaining this option's value if nonempty, or aRightcontaining the result of evaluatingright - See also
-
toRight
- Inherited from:
- Option
- Source
- Option.scala
Returns a singleton list containing the scala.Option's value if it is nonempty, or the empty list if the scala.Option is empty.
Returns a singleton list containing the scala.Option's value if it is nonempty, or the empty list if the scala.Option is empty.
This is equivalent to:
option match {
case Some(x) => List(x)
case None => Nil
}
Attributes
- Returns
-
a singleton list containing the option's value if nonempty, or the empty list if empty
- Inherited from:
- Option
- Source
- Option.scala
Returns a scala.util.Left containing the given argument left if this scala.Option is empty, or a scala.util.Right containing this scala.Option's value if this is nonempty.
Returns a scala.util.Left containing the given argument left if this scala.Option is empty, or a scala.util.Right containing this scala.Option's value if this is nonempty.
This is equivalent to:
option match {
case Some(x) => Right(x)
case None => Left(left)
}
Type parameters
- X
-
the type of the
Leftvalue
Value parameters
- left
-
the expression to evaluate and return if this is empty
Attributes
- Returns
-
a
Rightcontaining this option's value if nonempty, or aLeftcontaining the result of evaluatingleft - See also
-
toLeft
- Inherited from:
- Option
- Source
- Option.scala
Converts an Option of a pair into an Option of the first element and an Option of the second element.
Converts an Option of a pair into an Option of the first element and an Option of the second element.
This is equivalent to:
option match {
case Some((x, y)) => (Some(x), Some(y))
case _ => (None, None)
}
Type parameters
- A1
-
the type of the first half of the element pair
- A2
-
the type of the second half of the element pair
Value parameters
- asPair
-
an implicit conversion which asserts that the element type of this Option is a pair.
Attributes
- Returns
-
a pair of Options, containing, respectively, the first and second half of the element pair of this Option.
- Inherited from:
- Option
- Source
- Option.scala
Converts an Option of a triple into three Options, one containing the element from each position of the triple.
Converts an Option of a triple into three Options, one containing the element from each position of the triple.
This is equivalent to:
option match {
case Some((x, y, z)) => (Some(x), Some(y), Some(z))
case _ => (None, None, None)
}
Type parameters
- A1
-
the type of the first of three elements in the triple
- A2
-
the type of the second of three elements in the triple
- A3
-
the type of the third of three elements in the triple
Value parameters
- asTriple
-
an implicit conversion which asserts that the element type of this Option is a triple.
Attributes
- Returns
-
a triple of Options, containing, respectively, the first, second, and third elements from the element triple of this Option.
- Inherited from:
- Option
- Source
- Option.scala
Necessary to keep scala.Option from being implicitly converted to scala.collection.Iterable in for comprehensions.
Necessary to keep scala.Option from being implicitly converted to scala.collection.Iterable in for comprehensions.
Value parameters
- p
-
the predicate used to test elements
Attributes
- Inherited from:
- Option
- Source
- Option.scala
Returns a scala.Some formed from this option and another option by combining the corresponding elements in a pair. If either of the two options is empty, None is returned.
Returns a scala.Some formed from this option and another option by combining the corresponding elements in a pair. If either of the two options is empty, None is returned.
This is equivalent to:
(option1, option2) match {
case (Some(x), Some(y)) => Some((x, y))
case _ => None
}
Type parameters
- A1
-
a supertype of
A, the type of the first element of the resulting pair - B
-
the type of the second element of the resulting pair
Value parameters
- that
-
the options which is going to be zipped
Attributes
- Returns
-
a
Somecontaining a pair of both values if both options are nonempty, otherwiseNone - Example
-
// Returns Some(("foo", "bar")) because both options are nonempty. Some("foo") zip Some("bar") // Returns None because `that` option is empty. Some("foo") zip None // Returns None because `this` option is empty. None zip Some("bar") - Inherited from:
- Option
- Source
- Option.scala