Класс scala.Some

@SerialVersionUID(1234815782226070388L)

final case class Some[+A](value: A) extends Option[A]

Класс Some[A] представляет существующие значения типа A.

Наследуемые классы

Исходный код

класс WithFilter(p: A => Boolean)

Нам нужен целый класс WithFilter, чтобы соблюдать контракт «не создаёт новую коллекцию», хотя в коллекции с максимальным размером 1 это, вероятно, не имеет большого значения.

Конкретные методы

Исходный код

def get: A

Наследуемые методы

Исходный код@inline

final def collect[B](pf: PartialFunction[A, B]): Option[B]

Возвращает scala.Some, содержащий результат применения pf к содержащемуся значению этого scala.Option, если этот параметр не пуст и pf определена для этого значения. В противном случае возвращает None.

// 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}

Исходный код

final def contains[A1 >: A](elem: A1): Boolean

Проверяет, содержит ли параметр данное значение в качестве элемента.

Это эквивалентно:

option match {
 case Some(x) => x == elem
 case None    => false
}

// 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"

Исходный код@inline

final def exists(p: A => Boolean): Boolean

Возвращает true, если этот параметр не пуст, и предикат p возвращает true, когда он применяется к значению этого scala.Option. В противном случае возвращает false.

Это эквивалентно:

option match {
 case Some(x) => p(x)
 case None    => false
}

Исходный код@inline

final def filter(p: A => Boolean): Option[A]

Возвращает этот scala.Option, если он не пустой, и применение предиката p к значению этого scala.Option возвращает true. В противном случае возвращает None.

Это эквивалентно:

option match {
 case Some(x) if p(x) => Some(x)
 case _               => None
}

Исходный код@inline

final def filterNot(p: A => Boolean): Option[A]

Возвращает этот scala.Option, если он не пустой, и применение предиката p к значению этого scala.Option возвращает false. В противном случае возвращает None.

Это эквивалентно:

option match {
 case Some(x) if !p(x) => Some(x)
 case _                => None
}

Исходный код@inline

final def flatMap[B](f: A => Option[B]): Option[B]

Возвращает результат применения f к значению этого scala.Option, если этот scala.Option не пуст. Возвращает None если этот scala.Option пуст. Несколько отличается от map, так как ожидается, что f вернёт scala.Option (который может быть None).

Это эквивалентно:

option match {
 case Some(x) => f(x)
 case None    => None
}

Исходный код

def flatten[B](implicit ev: A <:< Option[B]): Option[B]

Возвращает вложенное значение scala.Option, если оно не пусто. В противном случае возвращает None.

Это эквивалентно:

option match {
 case Some(Some(b)) => Some(b)
 case _             => None
}

Some(Some("something")).flatten

Исходный код@inline

final def fold[B](ifEmpty: => B)(f: A => B): B

Возвращает результат применения f к значению этого scala.Option, если scala.Option не пустой. В противном случае вычисляет выражение ifEmpty.

Это эквивалентно:

option match {
 case Some(x) => f(x)
 case None    => ifEmpty
}

Это также эквивалентно:

option map f getOrElse ifEmpty

Исходный код@inline

final def forall(p: A => Boolean): Boolean

Возвращает true, если этот параметр пуст или предикат p возвращает true, когда применяется к значению этого scala.Option.

Это эквивалентно:

option match {
 case Some(x) => p(x)
 case None    => true
}

Исходный код@inline

final def foreach[U](f: A => U): Unit

Применяет заданную процедуру f к значению параметра, если он не пуст. В противном случае ничего не делает.

Это эквивалентно:

option match {
 case Some(x) => f(x)
 case None    => ()
}

Исходный код@inline

final def getOrElse[B >: A](default: => B): B

Возвращает значение опции, если опция не пуста, в противном случае возвращает результат вычисления default.

Это эквивалентно:

option match {
 case Some(x) => x
 case None    => default
}

Исходный код

final def isDefined: Boolean

Возвращает true, если опция является экземпляром scala.Some, в противном случае возвращает false.

Это эквивалентно:

option match {
 case Some(_) => true
 case None    => false
}

Исходный код

final def isEmpty: Boolean

Возвращает true, если опция пуста, в противном случае возвращает false.

Это эквивалентно:

option match {
 case Some(_) => false
 case None    => true
}

Исходный код

def iterator: Iterator[A]

Возвращает итератор, возвращающий значение scala.Option, если оно не пустое, или пустой итератор, если опция пуста.

Исходный код

final override def knownSize: Int

Исходный код@inline

final def map[B](f: A => B): Option[B]

Возвращает scala.Some, содержащий результат применения f к значению этой scala.Option, если эта scala.Option не пуста. В противном случае возвращает None.

Это эквивалентно:

option match {
 case Some(x) => Some(f(x))
 case None    => None
}

Исходный код

final def nonEmpty: Boolean

Возвращает false, если опция пуста, в противном случае возвращает true.

Это эквивалентно:

option match {
 case Some(_) => true
 case None    => false
}

Исходный код@inline

final def orElse[B >: A](alternative: => Option[B]): Option[B]

Возвращает этот scala.Option, если он не пустой, в противном случае возвращает результат вычисления alternative.

Это эквивалентно:

option match {
 case Some(x) => Some(x)
 case None    => alternative
}

Исходный код@inline

final def orNull[A1 >: A](implicit ev: Null <: A1): A1

Возвращает значение опции, если она не пустая, или null, если она пустая.

Хотя использование null не рекомендуется, код, написанный для использования scala.Option, часто должен взаимодействовать с кодом, который ожидает и возвращает null.

Это эквивалентно:

option match {
 case Some(x) => x
 case None    => null
}

val initialText: Option[String] = getInitialText
val textField = new JComponent(initialText.orNull,20)

Исходный код

def productElementNames: Iterator[String]

Итератор по именам всех элементов этого произведения.

Исходный код

def productIterator: Iterator[Any]

Итератор по всем элементам этого произведения.

Исходный код

def stepper[S <: Stepper[_]](implicit shape: StepperShape[A, S]): S

Возвращает scala.collection.Stepper для элементов этого набора.

Stepper позволяет создавать Java-поток для работы с набором, см. scala.jdk.StreamConverters. Для наборов, содержащих примитивные значения, Stepper можно использовать как итератор, который не упаковывает элементы.

Неявный параметр scala.collection.StepperShape определяет тип возвращаемого Stepper в соответствии с типом элемента этого набора.

• Для наборов, содержащих Int, Short, Byte или Char, возвращается scala.collection.IntStepper

• Для наборов, содержащих Double или Float, возвращается scala.collection.DoubleStepper

• Для наборов, содержащих Long, возвращается scala.collection.LongStepper

• Для любого другого типа элемента возвращается scala.collection.AnyStepper

Обратите внимание, что этот метод переопределен в подклассах, и тип возвращаемого значения уточняется до S with EfficientSplit, например scala.collection.IndexedSeqOps.stepper. Для Steppers, помеченных scala.collection.Stepper.EfficientSplit, конвертеры в scala.jdk.StreamConverters позволяют создавать параллельные потоки, в то время как обычные Steppers можно преобразовать только в последовательные потоки.

Исходный код@inline

final def toLeft[X](right: => X): Either[A, X]

Возвращает scala.util.Right, содержащий переданный аргумент right, если этот набор пустой, или scala.util.Left, содержащий значение этого scala.Option, если этот scala.Option не пустой.

Это эквивалентно:

option match {
 case Some(x) => Left(x)
 case None    => Right(right)
}

Исходный код

def toList: List[A]

Возвращает список, содержащий значение scala.Option, если оно не пустое, или пустой список, если scala.Option пустое.

Это эквивалентно:

option match {
 case Some(x) => List(x)
 case None    => Nil
}

Исходный код@inline

final def toRight[X](left: => X): Either[X, A]

Возвращает scala.util.Left содержащий переданный аргумент left если этот scala.Option пуст, или scala.util.Right содержащий значение этого scala.Option, если он не пуст.

Это эквивалентно:

option match {
 case Some(x) => Right(x)
 case None    => Left(left)
}

Исходный код

final def unzip[A1, A2](implicit asPair: A <:< (A1, A2)): (Option[A1], Option[A2])

Преобразует Option пары в Option первого элемента и Option второго элемента.

Это эквивалентно:

option match {
  case Some((x, y)) => (Some(x), Some(y))
  case _            => (None,    None)
}

Исходный код

final def unzip3[A1, A2, A3](implicit asTriple: A <:< (A1, A2, A3)): (Option[A1], Option[A2], Option[A3])

Преобразует Option тройки в три Option, каждый содержащий элемент из каждой позиции тройки.

Это эквивалентно:

option match {
  case Some((x, y, z)) => (Some(x), Some(y), Some(z))
  case _               => (None,    None,    None)
}

Исходный код@inline

final def withFilter(p: A => Boolean): WithFilter

Необходимо для предотвращения неявного преобразования scala.Option в scala.collection.Iterable в for выражениях.

Исходный код

final def zip[A1 >: A, B](that: Option[B]): Option[(A1, B)]

Возвращает scala.Some, образованную из этого Option и другого Option путем объединения соответствующих элементов в пару. Если любой из двух Option пуст, возвращается None.

Это эквивалентно:

(option1, option2) match {
  case (Some(x), Some(y)) => Some((x, y))
  case _                  => None
}

// 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")