Spec-Zone.ru › Scala 2.12 Library

Класс scala.Option

Объект-компаньон объект Option

запечатанный абстрактный класс Option[+A] extends Product с Serializable

Представляет необязательные значения. Экземпляры Option являются либо экземпляром scala.Some, либо объектом None.

Наиболее идиоматичный способ использования экземпляра scala.Option — рассматривать его как коллекцию или монаду и использовать map, flatMap, filter, или foreach:

val name: Option[String] = request getParameter "name"
val upper = name map { _.trim } filter { _.length != 0 } map { _.toUpperCase }
println(upper getOrElse "")

Обратите внимание, что это эквивалентно

val upper = for {
  name <- request getParameter "name"
  trimmed <- Some(name.trim)
  upper <- Some(trimmed.toUpperCase) if trimmed.length != 0
} yield upper
println(upper getOrElse "")

Из-за того, как работает выражение for comprehension, если из request.getParameter возвращается None, всё выражение приводит к None

Это позволяет элегантно комбинировать значения scala.Option без необходимости проверки наличия значения.

Эти полезные методы существуют как для scala.Some, так и для None.

  • isDefined — Истина, если не пусто
  • isEmpty — Истина, если пусто
  • nonEmpty — Истина, если не пусто
  • orElse — Оценивает и возвращает альтернативное необязательное значение, если пусто
  • getOrElse — Оценивает и возвращает альтернативное значение, если пусто
  • get — Возвращает значение, бросает исключение, если пусто
  • fold — Применяет функцию к необязательному значению, возвращает значение по умолчанию, если пусто
  • map — Применяет функцию к необязательному значению
  • flatMap — То же, что и map, но функция должна возвращать необязательное значение
  • foreach — Применяет процедуру к значению опции
  • collect — Применяет частичный шаблонный поиск к необязательному значению
  • filter — Необязательное значение удовлетворяет предикату
  • filterNot — Необязательное значение не удовлетворяет предикату
  • exists — Применяет предикат к необязательному значению или возвращает ложь, если пусто
  • forall — Применяет предикат к необязательному значению, или истинно, если пусто
  • contains — Проверяет, равен ли элемент необязательному значению, или ложь, если пусто
  • toList — Единичный список необязательного значения, в противном случае пустой список

Менее идиоматичный способ использования значений scala.Option — через сопоставление с образцом:

val nameMaybe = request getParameter "name"
nameMaybe match {
  case Some(name) =>
    println(name.trim.toUppercase)
  case None =>
    println("No name value")
}

Взаимодействие с кодом, который иногда может возвращать null, можно безопасно обернуть в scala.Option, чтобы получить None, а в противном случае — scala.Some.

val abc = new java.util.HashMap[Int, String]
abc.put(1, "A")
bMaybe = Option(abc.get(2))
bMaybe match {
  case Some(b) =>
    println(s"Found $b")
  case None =>
    println("Not found")
}
Тип-сам
Option[A]
Аннотации
@SerialVersionUID()
Источник
Option.scala
С момента

1.1

Примечание

Многие методы здесь дублируют методы в иерархии Traversable, но они дублируются по причине: неявное преобразование, как правило, приводит к Iterable в ситуациях, где можно было сохранить Option.

Линейные супертипы
Известные подклассы

Члены-типы

класс WithFilter extends AnyRef

Абстрактные члены-значения

абстрактный def canEqual(that: Any): Boolean

Метод, который должен вызываться в каждом хорошо спроектированном методе equals, открытом для переопределения в подклассе. См. Programming in Scala, Глава 28 для обсуждения и проектирования.

that

значение, проверяемое на возможное равенство

возвращает

true, если этот экземпляр потенциально может быть равен that, иначе false

Определяющие классы
Equals

абстрактный def get: A

Возвращает значение опции.

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

option match {
  case Some(x) => x
  case None    => throw new Exception
}
Исключения

java.util.NoSuchElementException, если опция пустая.

Примечание

Опция должна быть непустой.

абстрактный def isEmpty: Boolean

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

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

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

абстрактный def productArity: Int

Размер этого продукта.

возвращает

для продукта A(x1, ..., xk), возвращает k

Определяющие классы
Product

абстрактный def productElement(n: Int): Any

n-й элемент этого продукта (нумерация с 0). Другими словами, для продукта A(x1, ..., xk), возвращает x(n+1), где 0 <= n < k.

n

индекс возвращаемого элемента

возвращает

элемент n элементов после первого элемента

Определяющие классы
Product
Исключения

Члены-значения конкретных типов

final def !=(arg0: Any): Boolean

Проверка двух объектов на неравенство.

returns

true если !(this == that), в противном случае false.

Definition Classes
AnyRef → Any

final def ##(): Int

Эквивалентно x.hashCode, за исключением упакованных числовых типов и null. Для числовых типов возвращает значение хеша, согласованное с равенством значений: если две экземпляра типа значений сравниваются как true, то ## вернёт одинаковое значение хеша для каждого из них. Для null возвращает код хеша, где null.hashCode вызывает NullPointerException.

returns

значение хеша, согласованное с ==

Definition Classes
AnyRef → Any

def +(other: String): String

Неявный
Этот член добавлен неявным преобразованием из Option[A] в any2stringadd[Option[A]] с помощью метода any2stringadd в scala.Predef.
Definition Classes
any2stringadd

def ++[B >: A, That](that: GenTraversableOnce[B])(implicit bf: CanBuildFrom[collection.Iterable[A], B, That]): That

Возвращает новую итерируемую коллекцию, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда. Тип элементов итерируемой коллекции является наиболее специфическим суперклассом, охватывающим типы элементов двух операндов.

B

тип элемента возвращаемой коллекции.

That

класс возвращаемой коллекции. В возможности, That — это тот же класс, что и текущий класс коллекции Repr, но это зависит от того, может ли тип элемента B быть допустимым для этого класса, что означает, что найден неявный экземпляр типа CanBuildFrom[Repr, B, That].

that

итерируемый для добавления.

bf

неявное значение класса CanBuildFrom, которое определяет возвращаемый класс That по типу текущей репрезентации Repr и новому типу элемента B.

returns

новая коллекция типа That, которая содержит все элементы этой итерируемой коллекции, за которыми следуют все элементы that.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike

def ++:[B >: A, That](that: collection.Traversable[B])(implicit bf: CanBuildFrom[collection.Iterable[A], B, That]): That

Как и ++, возвращает новую коллекцию, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда.

Отличается от ++ тем, что правый операнд определяет тип возвращаемой коллекции, а не левый. Мнемоника: двоеточие находится с той стороны нового типа коллекции.

Пример:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)

Этот перегруз существует, потому что: для реализации ++: мы должны повторно использовать реализацию ++, потому что многие коллекции переопределяют её с более эффективными версиями.

Так как TraversableOnce не имеет метода ++, мы должны реализовать его непосредственно, но Traversable и ниже могут использовать перегруз.

B

тип элемента возвращаемой коллекции.

That

класс возвращаемой коллекции. В возможности, That — это тот же класс, что и текущий класс коллекции Repr, но это зависит от того, может ли тип элемента B быть допустимым для этого класса, что означает, что найден неявный экземпляр типа CanBuildFrom[Repr, B, That].

that

итерируемый для добавления.

bf

неявное значение класса CanBuildFrom, которое определяет возвращаемый класс That по типу текущей репрезентации Repr и новому типу элемента B.

returns

новая коллекция типа That, которая содержит все элементы этой итерируемой коллекции, за которыми следуют все элементы that.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike

def ++:[B](that: collection.TraversableOnce[B]): Option[B]

[случай использования]

Как и ++, возвращает новую коллекцию, содержащую элементы из левого операнда, за которыми следуют элементы из правого операнда.

Она отличается от ++ тем, что правый операнд определяет тип результирующей коллекции, а не левый. Мемоническое правило: двоеточие находится на стороне типа новой коллекции.

Пример:

scala> val x = List(1)
x: List[Int] = List(1)

scala> val y = LinkedList(2)
y: scala.collection.mutable.LinkedList[Int] = LinkedList(2)

scala> val z = x ++: y
z: scala.collection.mutable.LinkedList[Int] = LinkedList(1, 2)
B

тип элемента возвращаемой коллекции.

that

перечисляемый объект для добавления.

возвращает

новый параметр, который содержит все элементы этого параметра, за которыми следуют все элементы that.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы-определения
TraversableLike
Полная сигнатура

def ->[B](y: B): (Option[A], B)

Неявный
Этот член добавлен неявным преобразованием из Option[A] в ArrowAssoc[Option[A]] с помощью метода ArrowAssoc в scala.Predef.
Классы-определения
ArrowAssoc
Аннотации
@inline()

def /:[B](z: B)(op: (B, A) ⇒ B): B

Применяет бинарный оператор к начальному значению и всем элементам этой итерируемой коллекции слева направо.

Примечание: /: — это альтернативная запись для foldLeft; z /: xs эквивалентно xs foldLeft z.

Примеры:

Обратите внимание, что функция свертки, используемая для вычисления b, эквивалентна той, которая используется для вычисления c.

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (5 /: a)(_+_)
b: Int = 15

scala> val c = (5 /: a)((x,y) => x + y)
c: Int = 15

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

z

начальное значение.

op

бинарный оператор.

возвращает

результат вставки op между последовательными элементами этой итерируемой коллекции слева направо с начальным значением z слева:

op(...op(op(z, x_1), x_2), ..., x_n)

где x1, ..., xn — элементы этой итерируемой коллекции.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы-определения
TraversableOnce → GenTraversableOnce

def :\[B](z: B)(op: (A, B) ⇒ B): B

Применяет бинарный оператор ко всем элементам этой итерируемой коллекции и начальному значению, справа налево.

Примечание: :\ — это альтернативная запись для foldRight; xs :\ z эквивалентно xs foldRight z.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен или оператор не ассоциативен и коммутативен.

Примеры:

Обратите внимание, что функция свертки, используемая для вычисления b, эквивалентна той, которая используется для вычисления c.

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = (a :\ 5)(_+_)
b: Int = 15

scala> val c = (a :\ 5)((x,y) => x + y)
c: Int = 15
B

тип результата бинарного оператора.

z

начальное значение.

op

бинарный оператор.

возвращает

результат вставки op между последовательными элементами этой итерируемой коллекции справа налево с начальным значением z справа:

op(x_1, op(x_2, ... op(x_n, z)...))

где x1, ..., xn — элементы этой итерируемой коллекции.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы-определения
TraversableOnce → GenTraversableOnce

final def ==(arg0: Any): Boolean

Выражение x == that эквивалентно if (x eq null) that eq null else x.equals(that).

возвращает

true если объект-получатель эквивалентен аргументу; false в противном случае.

Классы-определения
AnyRef → Any

def addString(b: StringBuilder): StringBuilder

Добавляет все элементы этой итерируемой коллекции в строковый билдер. Записываемый текст состоит из строковых представлений (в соответствии с методом toString) всех элементов этой итерируемой коллекции без разделительной строки.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> val h = a.addString(b)
h: StringBuilder = 1234
b

строковый билдер, в который добавляются элементы.

возвращает

строковый билдер b , в который были добавлены элементы.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы-определения
TraversableOnce

def addString(b: StringBuilder, sep: String): StringBuilder

Добавляет все элементы этой итерируемой коллекции в строковый билдер, используя разделительную строку. Записанный текст состоит из строковых представлений (относительно метода toString) всех элементов этой итерируемой коллекции, разделенных строкой sep.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b, ", ")
res0: StringBuilder = 1, 2, 3, 4
b

строковый билдер, к которому добавляются элементы.

sep

разделительная строка.

returns

строковый билдер b, к которому были добавлены элементы.

Implicit
Этот член добавляется неявным преобразованием из Option[A] в Iterable[A], выполняемым методом option2Iterable в scala.Option.
Definition Classes
TraversableOnce

def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

Добавляет все элементы этой итерируемой коллекции в строковый билдер, используя начальную, конечную и разделительную строки. Записанный текст начинается со строки start и заканчивается строкой end. Внутри, строковые представления (относительно метода toString) всех элементов этой итерируемой коллекции разделены строкой sep.

Пример:

scala> val a = List(1,2,3,4)
a: List[Int] = List(1, 2, 3, 4)

scala> val b = new StringBuilder()
b: StringBuilder =

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)
b

строковый билдер, к которому добавляются элементы.

start

начальная строка.

sep

разделительная строка.

end

конечная строка.

returns

строковый билдер b, к которому были добавлены элементы.

Implicit
Этот член добавляется неявным преобразованием из Option[A] в Iterable[A], выполняемым методом option2Iterable в scala.Option.
Definition Classes
TraversableOnce

def aggregate[B](z: ⇒ B)(seqop: (B, A) ⇒ B, combop: (B, B) ⇒ B): B

Агрегирует результаты применения оператора к последующим элементам.

Это более общая форма fold и reduce. Она похожа на foldLeft тем, что не требует, чтобы результат был супертипом типа элемента. Кроме того, она позволяет обрабатывать параллельные коллекции по частям, а затем объединять промежуточные результаты.

aggregate разбивает итерируемую коллекцию на разделы и обрабатывает каждый раздел, последовательно применяя seqop, начиная с z (как foldLeft). Затем эти промежуточные результаты объединяются с помощью combop (как fold). Реализация этой операции может работать с произвольным числом разделов коллекции (даже 1), поэтому combop может вызываться произвольное количество раз (даже 0).

В качестве примера рассмотрим суммирование целочисленных значений списка символов. Начальное значение суммы равно 0. Сначала seqop преобразует каждый входной символ в Int и добавляет его к сумме (раздела). Затем combop просто нужно суммировать промежуточные результаты разделов:

List('a', 'b', 'c').aggregate(0)({ (sum, ch) => sum + ch.toInt }, { (p1, p2) => p1 + p2 })
B

тип накопленных результатов

z

начальное значение для накопленного результата раздела - это обычно будет нейтральный элемент для оператора seqop (например, Nil для конкатенации списков или 0 для суммирования) и может вычисляться более одного раза

seqop

оператор, используемый для накопления результатов внутри раздела

combop

ассоциативный оператор, используемый для объединения результатов из разных разделов

Implicit
Этот член добавляется неявным преобразованием из Option[A] в Iterable[A], выполняемым методом option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce

final def asInstanceOf[T0]: T0

Преобразует принимаемый объект в тип T0.

Обратите внимание, что успешность преобразования во время выполнения зависит от семантики стирания Scala. Поэтому выражение 1.asInstanceOf[String] вызовет ClassCastException во время выполнения, а выражение List(1).asInstanceOf[List[String]] - нет. В последнем примере, поскольку параметр типа стирается во время компиляции, невозможно проверить, соответствуют ли содержимые списка запрашиваемому типу.

returns

принимаемый объект.

Definition Classes
Any
Exceptions thrown

ClassCastException если принимаемый объект не является экземпляром стирания типа T0.

def clone(): AnyRef

Создает копию принимаемого объекта.

Реализация метода clone по умолчанию зависит от платформы.

returns

копия принимаемого объекта.

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

не указан в SLS как член AnyRef

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

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

pf

частичная функция.

returns

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

Annotations
@inline()
Пример:
    // 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}

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

Находит первый элемент в итерируемой коллекции, для которого заданная частичная функция определена, и применяет к нему частичную функцию.

Примечание: может не завершиться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

pf

частичная функция

returns

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

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableOnce
Пример:

    Seq("a", 1, 5L).collectFirst({ case x: Int => x*10 }) = Some(10)

def companion: GenericCompanion[collection.Iterable]

Объект-компаньон-фабрика, который создает экземпляры класса Iterable. (или его Iterable суперкласс, где класс Iterable не является Seq.)

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
Iterable → GenIterable → Traversable → GenTraversable → GenericTraversableTemplate

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

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

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

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

элемент для проверки.

returns

true если параметр Option имеет элемент, равный (как определено ==) elem, 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"

def copyToArray(xs: Array[A], start: Int, len: Int): Unit

[use case]

Копирует элементы этого параметра Option в массив. Заполняет заданный массив xs не более чем len элементами этого параметра Option, начиная с позиции start. Копирование прекратится, когда будет достигнут конец текущего Option, конец целевого массива или len элементов будут скопированы.

xs

массив для заполнения.

start

индекс начала.

len

максимальное количество элементов для копирования.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce
Полная сигнатура

def copyToArray(xs: Array[A]): Unit

[use case]

Копирует элементы этого параметра Option в массив. Заполняет заданный массив xs значениями этого параметра Option. Копирование прекратится, когда будет достигнут конец текущего Option или конец целевого массива.

xs

массив для заполнения.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce
Полная сигнатура

def copyToArray(xs: Array[A], start: Int): Unit

[use case]

Копирует элементы этого параметра в массив. Заполняет предоставленный массив xs значениями этого параметра, начиная с индекса start. Копирование прекратится, как только будет достигнут конец текущего параметра или конец целевого массива.

xs

массив для заполнения.

start

начальный индекс.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы определений
TraversableOnce → GenTraversableOnce
Полная сигнатура

def copyToBuffer[B >: A](dest: Buffer[B]): Unit

Копирует все элементы этого итерируемого набора в буфер.

Примечание: не будет завершаться для коллекций бесконечного размера.

dest

Буфер, в который копируются элементы.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы определений
TraversableOnce

def count(p: (A) ⇒ Boolean): Int

Подсчитывает количество элементов в итерируемой коллекции, удовлетворяющих предикату.

p

предикат, используемый для проверки элементов.

возвращает

количество элементов, удовлетворяющих предикату p.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы определений
TraversableOnce → GenTraversableOnce

def drop(n: Int): collection.Iterable[A]

Выбирает все элементы, кроме первых n.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

n

количество элементов, которые нужно удалить из этой итерируемой коллекции.

возвращает

итерируемая коллекция, состоящая из всех элементов этой итерируемой коллекции, кроме первых n элементов, или же пустая итерируемая коллекция, если у этой итерируемой коллекции меньше n элементов. Если n отрицательное, элементы не удаляются.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы определений
IterableLike → TraversableLike → GenTraversableLike

def dropRight(n: Int): collection.Iterable[A]

Выбирает все элементы, кроме последних n.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

n

Количество элементов, которое нужно взять

возвращает

итерируемая коллекция, состоящая из всех элементов этой итерируемой коллекции, кроме последних n элементов, или же пустая итерируемая коллекция, если у этой итерируемой коллекции меньше n элементов.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы определений
IterableLike

def dropWhile(p: (A) ⇒ Boolean): collection.Iterable[A]

Удаляет самое длинное префикс элементов, удовлетворяющих предикату.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

возвращает

самое длинное суффикс этой итерируемой коллекции, первый элемент которого не удовлетворяет предикату p.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Классы определений
TraversableLike → GenTraversableLike

def ensuring(cond: (Option[A]) ⇒ Boolean, msg: ⇒ Any): Option[A]

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Ensuring[Option[A]] с помощью метода Ensuring в scala.Predef.
Классы определений
Ensuring

def ensuring(cond: (Option[A]) ⇒ Boolean): Option[A]

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Ensuring[Option[A]] при помощи метода Ensuring в scala.Predef.
Определения классов
Ensuring

def ensuring(cond: Boolean, msg: ⇒ Any): Option[A]

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Ensuring[Option[A]] при помощи метода Ensuring в scala.Predef.
Определения классов
Ensuring

def ensuring(cond: Boolean): Option[A]

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Ensuring[Option[A]] при помощи метода Ensuring в scala.Predef.
Определения классов
Ensuring

final def eq(arg0: AnyRef): Boolean

Проверяет, является ли аргумент (that) ссылкой на получаемый объект (this).

Метод eq реализует отношение эквивалентности на непустых экземплярах AnyRef, и имеет три дополнительных свойства:

    Он согласован: для любых непустых экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают true или последовательно возвращают false.Для любого непустого экземпляра x типа AnyRef, x.eq(null) и null.eq(x) возвращает false. null.eq(null) возвращает true.

При переопределении методов equals или hashCode важно обеспечить, чтобы их поведение соответствовало равенству ссылок. Поэтому, если два объекта являются ссылками друг на друга (o1 eq o2), они должны быть равны друг другу (o1 == o2) и они должны иметь одинаковое значение хэша (o1.hashCode == o2.hashCode).

возвращает

true если аргумент является ссылкой на получаемый объект; false в противном случае.

Определения классов
AnyRef

def equals(arg0: Any): Boolean

Метод равенства для ссылочных типов. Реализация по умолчанию делегирует вызов eq.

Смотрите также equals в scala.Any.

возвращает

true если получаемый объект эквивалентен аргументу; false в противном случае.

Определения классов
AnyRef → Any

final def exists(p: (A) ⇒ Boolean): Boolean

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

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

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

предикат для проверки

Аннотации
@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
}
p

предикат, используемый для проверки.

Аннотации
@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
}
p

предикат, используемый для проверки.

Аннотации
@inline()

def finalize(): Unit

Вызывается сборщиком мусора на получаемом объекте, когда на объект больше нет ссылок.

Подробности о том, когда и если вызывается метод finalize, а также взаимодействие finalize с нелокальными возвратами и исключениями, зависят от платформы.

Атрибуты
protected[lang]
Определения классов
AnyRef
Аннотации
@throws( classOf[java.lang.Throwable] )
Примечание

не определено SLS в качестве члена AnyRef

def find(p: (A) ⇒ Boolean): Option[A]

Находит первый элемент в итерируемой коллекции, удовлетворяющий предикату, если таковой существует.

Примечание: может не завершиться для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

p

предикат, используемый для проверки элементов.

returns

значение типа Option, содержащее первый элемент в итерируемой коллекции, удовлетворяющий p, или None в случае отсутствия такого элемента.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

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

функция для применения

Annotations
@inline()
См. также

map

foreach

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

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

ifEmpty

выражение для вычисления, если пусто.

f

функция для применения, если не пусто.

Annotations
@inline()

def foldLeft[B](z: B)(op: (B, A) ⇒ B): B

Применяет бинарную операцию к начальному значению и всем элементам этой итерируемой коллекции, слева направо.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если базовый тип коллекции не упорядочен или операция ассоциативна и коммутативна.

B

тип результата бинарной операции.

z

начальное значение.

op

бинарная операция.

returns

результат вставки op между последовательными элементами этой итерируемой коллекции, слева направо с начальным значением z слева:

op(...op(z, x_1), x_2, ..., x_n)

где x1, ..., xn - это элементы этой итерируемой коллекции. Возвращает z если эта итерируемая коллекция пуста.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce

def foldRight[B](z: B)(op: (A, B) ⇒ B): B

Применяет бинарную операцию ко всем элементам этой итерируемой коллекции и начальному значению, справа налево.

Примечание: не завершится для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если базовый тип коллекции не упорядочен или операция ассоциативна и коммутативна.

B

тип результата бинарной операции.

z

начальное значение.

op

бинарная операция.

returns

результат вставки op между последовательными элементами этой итерируемой коллекции, справа налево с начальным значением z справа:

op(x_1, op(x_2, ... op(x_n, z)...))

где x1, ..., xn - это элементы этой итерируемой коллекции. Возвращает z если эта итерируемая коллекция пуста.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
IterableLike → TraversableOnce → GenTraversableOnce

final def forall(p: (A) ⇒ Boolean): Boolean

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

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

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

предикат для проверки

Annotations
@inline()

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

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

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

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

процедура для применения.

Annotations
@inline()
См. также

map

flatMap

def formatted(fmtstr: String): String

Возвращает строку, отформатированную в соответствии с заданной format строкой. Строки формата аналогичны строкам формата String.format (@см. java.lang.String.format).

Неявный
Этот член добавлен неявным преобразованием из Option[A] в StringFormat[Option[A]], выполненное методом StringFormat в scala.Predef.
Определяющие классы
StringFormat
Annotations
@inline()

def genericBuilder[B]: Builder[B, collection.Iterable[B]]

Неявный генератор, который создает экземпляры Iterable для произвольных типов элементов.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненное методом option2Iterable в scala.Option.
Определяющие классы
GenericTraversableTemplate

final def getClass(): Class[_]

Возвращает представление класса объекта во время выполнения.

возвращает

объект класса, соответствующий типу получателя во время выполнения.

Определяющие классы
AnyRef → Any
Annotations
@native()

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

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

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

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

выражение по умолчанию.

Annotations
@inline()

def groupBy[K](f: (A) ⇒ K): Map[K, collection.Iterable[A]]

Разделяет эту коллекцию на карту итерируемых коллекций в соответствии с некоторой функцией-дискриминатором.

Примечание: этот метод не переопределяется представлениями. Это означает, что при применении к представлению он всегда заставляет представление работать и возвращает новую итерируемую коллекцию.

K

тип ключей, возвращаемых функцией-дискриминатором.

f

функция-дискриминатор.

возвращает

Карта из ключей к итерируемым коллекциям, удовлетворяющая следующему инварианту:

(xs groupBy f)(k) = xs filter (x => f(x) == k)

То есть каждый ключ k связан с итерируемой коллекцией тех элементов x, для которых f(x) равно k.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненное методом option2Iterable в scala.Option.
Определяющие классы
TraversableLike → GenTraversableLike

def grouped(size: Int): collection.Iterator[collection.Iterable[A]]

Разделяет элементы на итерируемые коллекции фиксированного размера.

size

количество элементов в группе

возвращает

Итератор, производящий итерируемые коллекции размера size, за исключением последней, которая будет меньше размера size, если элементы не делятся на размер равномерно.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненное методом option2Iterable в scala.Option.
Определяющие классы
IterableLike
См. также

scala.collection.Iterator, метод grouped

def hasDefiniteSize: Boolean

Проверяет, известно ли, что данная итерируемая коллекция имеет конечный размер. Все строгие коллекции известны как имеющие конечный размер. Для нестрогой коллекции, такой как Stream, предикат возвращает true если все элементы были вычислены. Он возвращает false если поток ещё не был проанализирован до конца. Непустые итераторы обычно возвращают false даже если они были созданы из коллекции с известным конечным размером.

Примечание: многие методы коллекций не будут работать с коллекциями бесконечных размеров. Типичный режим сбоя — бесконечный цикл. Эти методы всегда пытаются пройтись по коллекции, не проверяя сначала, что hasDefiniteSize возвращает true. Однако проверка hasDefiniteSize может гарантировать, что размер определён и не будет проблем с бесконечной итерацией.

returns

true если данная коллекция имеет известный конечный размер, false в противном случае.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike → TraversableOnce → GenTraversableOnce

def hashCode(): Int

Метод hashCode для ссылочных типов. См. hashCode в scala.Any.

returns

значение хэш-кода для этого объекта.

Definition Classes
AnyRef → Any
Annotations
@native()

def head: A

Выбирает первый элемент этой итерируемой коллекции.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

returns

первый элемент этой итерируемой коллекции.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
IterableLike → TraversableLike → GenTraversableLike
Исключения

NoSuchElementException если итерируемая коллекция пуста.

def headOption: Option[A]

Возвращает опционально первый элемент.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

returns

первый элемент этой итерируемой коллекции, если она не пуста, None если она пуста.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike

def init: collection.Iterable[A]

Выбирает все элементы, кроме последнего.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

returns

итерируемая коллекция, состоящая из всех элементов этой итерируемой коллекции, кроме последнего.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike
Исключения

UnsupportedOperationException если итерируемая коллекция пуста.

def inits: collection.Iterator[collection.Iterable[A]]

Итерирует по префиксам (inits) этой итерируемой коллекции. Первое значение будет этой итерируемой коллекцией, а последнее — пустой итерируемой коллекцией, промежуточные значения будут результатами последовательных применений init.

returns

итератор по всем префиксам (inits) этой итерируемой коллекции

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike
Пример:

    List(1,2,3).inits = Iterator(List(1,2,3), List(1,2), List(1), Nil)

def isDefined: Boolean

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

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

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

final def isInstanceOf[T0]: Boolean

Проверяет, является ли динамический тип объекта-получателя T0.

Обратите внимание, что результат проверки модульный по семантике стирания Scala. Поэтому выражение 1.isInstanceOf[String] вернёт false, в то время как выражение List(1).isInstanceOf[List[String]] вернёт true. В последнем примере, поскольку аргумент типа стирается во время компиляции, невозможно проверить, содержатся ли элементы списка указанного типа.

returns

true если объект-получатель является экземпляром стёртого типа T0; false в противном случае.

Definition Classes
Any

final def isTraversableAgain: Boolean

Проверяет, можно ли многократно перебирать этот итерируемый набор.

returns

true

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненное методом option2Iterable в scala.Option.
Классы определений
TraversableLike → GenTraversableLike → GenTraversableOnce

def iterator: Iterator[A]

def last: A

Выбирает последний элемент.

Примечание: могут быть получены разные результаты при разных запусках, если тип базового набора не упорядочен.

returns

Последний элемент этого итерируемого набора.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненное методом option2Iterable в scala.Option.
Классы определений
TraversableLike → GenTraversableLike
Исключения

NoSuchElementException Если итерируемый набор пуст.

def lastOption: Option[A]

Возвращает опционально последний элемент.

Примечание: могут быть получены разные результаты при разных запусках, если тип базового набора не упорядочен.

returns

последний элемент этого итерируемого набора, если он непустой, None если он пустой.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненное методом option2Iterable в scala.Option.
Классы определений
TraversableLike → GenTraversableLike

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

функция для применения

Аннотации
@inline()
Примечание

Это похоже на flatMap за исключением того, что f не нужно заключать результат в scala.Option.

См. также

flatMap

foreach

def max: A

[use case]

Находит наибольший элемент.

returns

наибольший элемент этого опционального значения.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненное методом option2Iterable в scala.Option.
Классы определений
TraversableOnce → GenTraversableOnce
Полная сигнатура
Исключения

UnsupportedOperationException если этот опцион пуст.

def maxBy[B](f: (A) ⇒ B): A

[use case]

Находит первый элемент, который дает наибольшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

returns

первый элемент этого опционального значения с наибольшим значением, измеренным функцией f.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненное методом option2Iterable в scala.Option.
Классы определений
TraversableOnce → GenTraversableOnce
Полная сигнатура
Исключения

UnsupportedOperationException если этот опцион пуст.

def min: A

[use case]

Находит наименьший элемент.

returns

наименьший элемент этого варианта

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] в методе option2Iterable в scala.Option.
Классы определения
TraversableOnce → GenTraversableOnce
Полная подпись
Исключения

UnsupportedOperationException если этот вариант пуст.

def minBy[B](f: (A) ⇒ B): A

[use case]

Находит первый элемент, который дает наименьшее значение, измеренное функцией f.

B

Тип результата функции f.

f

Функция измерения.

returns

первый элемент этого варианта с наименьшим значением, измеренным функцией f.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] в методе option2Iterable в scala.Option.
Классы определения
TraversableOnce → GenTraversableOnce
Полная подпись
Исключения

UnsupportedOperationException если этот вариант пуст.

def mkString: String

Отображает все элементы этого итерируемого набора в строке.

returns

строковое представление этого итерируемого набора. В результирующей строке строковые представления (в соответствии с методом toString) всех элементов этого итерируемого набора следуют друг за другом без разделительной строки.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] в методе option2Iterable в scala.Option.
Классы определения
TraversableOnce → GenTraversableOnce

def mkString(sep: String): String

Отображает все элементы этого итерируемого набора в строке, используя разделительную строку.

sep

разделительная строка.

returns

строковое представление этого итерируемого набора. В результирующей строке строковые представления (в соответствии с методом toString) всех элементов этого итерируемого набора разделены строкой sep.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] в методе option2Iterable в scala.Option.
Классы определения
TraversableOnce → GenTraversableOnce
Пример:

    List(1, 2, 3).mkString("|") = "1|2|3"

def mkString(start: String, sep: String, end: String): String

Отображает все элементы этого итерируемого набора в строке, используя начальную, конечную и разделительные строки.

start

начальная строка.

sep

разделительная строка.

end

конечная строка.

returns

строковое представление этого итерируемого набора. Результирующая строка начинается со строки start и заканчивается строкой end. Внутри, строковые представления (в соответствии с методом toString) всех элементов этого итерируемого набора разделены строкой sep.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] в методе option2Iterable в scala.Option.
Классы определения
TraversableOnce → GenTraversableOnce
Пример:

    List(1, 2, 3).mkString("(", "; ", ")") = "(1; 2; 3)"

final def ne(arg0: AnyRef): Boolean

Эквивалентно !(this eq that).

returns

true если аргумент не является ссылкой на объект-получатель; false в противном случае.

Классы определения
AnyRef

final def nonEmpty: Boolean

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

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

option match {
  case Some(_) => true
  case None    => false
}
Примечание

Реализовано здесь, чтобы избежать неявного преобразования в Iterable.

final def notify(): Unit

Разбуждает единственную нить, которая ожидает монитора объекта-получателя.

Классы определения
AnyRef
Аннотации
@native()
Примечание

не указано SLS как член AnyRef

final def notifyAll(): Unit

Разбуживает все потоки, ожидающие монитора объекта-приёмника.

Definition Classes
AnyRef
Annotations
@native()
Note

не указан SLS как член AnyRef

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

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

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

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

выражение-альтернатива.

Annotations
@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
}
Annotations
@inline()
Пример:
    val initialText: Option[String] = getInitialText
    val textField = new JComponent(initialText.orNull,20)

def par: ParIterable[A]

Возвращает параллельную реализацию этого набора.

Для большинства типов наборов этот метод создаёт новый параллельный набор, копируя все элементы. Для этих наборов par занимает линейное время. Изменяемые наборы в этой категории не создают изменяемый параллельный набор с той же основой данных, поэтому изменения в одном наборе не будут отражены в другом.

Специальные наборы (например, ParArray или mutable.ParHashMap) переопределяют это поведение по умолчанию, создавая параллельный набор, который использует ту же самую основную базу данных. Для этих наборов par занимает постоянное или суб-линейное время.

Все параллельные наборы возвращают ссылку на себя.

returns

параллельная реализация этого набора

Implicit
Этот член добавлен неявным преобразованием от Option[A] к Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
Parallelizable

def partition(p: (A) ⇒ Boolean): (collection.Iterable[A], collection.Iterable[A])

Разделяет этот итерируемый набор на два итерируемых набора в соответствии с предикатом.

p

предикат для разделения.

returns

пара итерируемых наборов: первый итерируемый набор состоит из всех элементов, которые удовлетворяют предикату p, а второй итерируемый набор состоит из всех элементов, которые не удовлетворяют его. Относительный порядок элементов в полученных итерируемых наборах такой же, как и в исходном итерируемом наборе.

Implicit
Этот член добавлен неявным преобразованием от Option[A] к Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike

def product: A

[use case]

Перемножает элементы этого набора.

returns

произведение всех элементов в этом наборе опций чисел типа Int. Вместо Int, может быть использован любой другой тип T с неявной Numeric[T] реализацией как тип элемента опции и как тип результата product. Примеры таких типов: Long, Float, Double, BigInt.

Implicit
Этот член добавлен неявным преобразованием от Option[A] к Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce
Полная подпись

def productIterator: Iterator[Any]

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

returns

в реализации по умолчанию, Iterator[Any]

Definition Classes
Product

def productPrefix: String

Строка, используемая в методах toString производных классов. Реализации могут переопределить этот метод, чтобы добавить строковый префикс к результату методов toString.

returns

в реализации по умолчанию, пустая строка

Definition Classes
Product

def reduce[A1 >: A](op: (A1, A1) ⇒ A1): A1

Уменьшает элементы этого итерируемого набора, используя указанный ассоциативный бинарный оператор.

Порядок выполнения операций над элементами не определен и может быть не детерминированным.

A1

Тип параметр для бинарного оператора, супертип A.

op

Бинарный оператор, который должен быть ассоциативным.

returns

Результат применения оператора reduce op к всем элементам, если итерируемый набор не пустой.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] выполненное методом option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce
Исключения

UnsupportedOperationException, если этот итерируемый набор пустой.

def reduceLeft[B >: A](op: (B, A) ⇒ B): B

Применяет бинарный оператор ко всем элементам этого итерируемого набора слева направо.

Примечание: не завершит работу для бесконечных наборов.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этого итерируемого набора слева направо:

op( op( ... op(x_1, x_2) ..., x_{n-1}), x_n)

где x1, ..., xn — элементы этого итерируемого набора.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] выполненное методом option2Iterable в scala.Option.
Исключения

UnsupportedOperationException, если этот итерируемый набор пустой.

def reduceLeftOption[B >: A](op: (B, A) ⇒ B): Option[B]

Необязательно применяет бинарный оператор ко всем элементам этого итерируемого набора слева направо.

Примечание: не завершит работу для бесконечных наборов.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

значение Option, содержащее результат reduceLeft(op), если этот итерируемый набор не пустой, None в противном случае.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] выполненное методом option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce

def reduceOption[A1 >: A](op: (A1, A1) ⇒ A1): Option[A1]

Уменьшает элементы этого итерируемого набора, если таковые имеются, используя указанный ассоциативный бинарный оператор.

Порядок выполнения операций над элементами не определен и может быть не детерминированным.

A1

Тип параметр для бинарного оператора, супертип A.

op

Бинарный оператор, который должен быть ассоциативным.

returns

Значение Option, содержащее результат применения оператора reduce op к всем элементам, если набор не пустой, и None в противном случае.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] выполненное методом option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce

def reduceRight[B >: A](op: (A, B) ⇒ B): B

Применяет бинарный оператор ко всем элементам этого итерируемого набора справа налево.

Примечание: не завершит работу для бесконечных наборов.

Примечание: может возвращать разные результаты для разных запусков, если тип базового набора не упорядочен или оператор не ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

результат вставки op между последовательными элементами этого итерируемого набора справа налево:

op(x_1, op(x_2, ..., op(x_{n-1}, x_n)...))

где x1, ..., xn — элементы этого итерируемого набора.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] выполненное методом option2Iterable в scala.Option.
Definition Classes
IterableLike → TraversableOnce → GenTraversableOnce
Исключения

UnsupportedOperationException, если этот итерируемый набор пустой.

def reduceRightOption[B >: A](op: (A, B) ⇒ B): Option[B]

Применяет бинарный оператор ко всем элементам этого итерируемого набора, слева направо.

Примечание: не завершит работу для коллекций бесконечного размера.

Примечание: может возвращать разные результаты для разных запусков, если только тип базовой коллекции не упорядочен или оператор ассоциативен и коммутативен.

B

тип результата бинарного оператора.

op

бинарный оператор.

returns

значение опции, содержащее результат вычисления, если этот итерируемый набор не пустой, иначе None.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce

def repr: collection.Iterable[A]

Коллекция типа итерируемая коллекция, лежащая в основе этого объекта TraversableLike. По умолчанию она реализуется как сам объект TraversableLike, но это можно переопределить.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike

def sameElements(that: GenIterable[A]): Boolean

[use case]

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

that

коллекция для сравнения.

returns

true, если обе коллекции содержат одинаковые элементы в одинаковом порядке, иначе false.

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
IterableLike → GenIterableLike
Полная сигнатура

def scan[B >: A, That](z: B)(op: (B, B) ⇒ B)(implicit cbf: CanBuildFrom[collection.Iterable[A], B, That]): That

Вычисляет префиксный сканирование элементов коллекции.

Примечание: нейтральный элемент z может применяться более одного раза.

B

тип элементов результирующей коллекции

That

тип результирующей коллекции

z

нейтральный элемент для оператора op

op

ассоциативный оператор для сканирования

cbf

фабрика объединений, которая предоставляет объединитель

returns

новая итерируемая коллекция, содержащая префиксное сканирование элементов в этой итерируемой коллекции

Implicit
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike

def scanLeft[B, That](z: B)(op: (B, A) ⇒ B)(implicit bf: CanBuildFrom[collection.Iterable[A], B, That]): That

Создаёт коллекцию, содержащую кумулятивные результаты применения оператора слева направо.

Примечание: не завершается для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

B

тип элементов в результирующей коллекции

That

фактический тип результирующей коллекции

z

начальное значение

op

бинарный оператор, применяемый к промежуточному результату и элементу

bf

явное значение класса CanBuildFrom, определяющее класс результата That на основе текущего типа представления Repr и нового типа элемента B.

returns

коллекция с промежуточными результатами

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
TraversableLike → GenTraversableLike

def scanRight[B, That](z: B)(op: (A, B) ⇒ B)(implicit bf: CanBuildFrom[collection.Iterable[A], B, That]): That

Создаёт коллекцию, содержащую кумулятивные результаты применения оператора справа налево. Голова коллекции — последний кумулятивный результат.

Примечание: не завершается для коллекций бесконечного размера.

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

Пример:

List(1, 2, 3, 4).scanRight(0)(_ + _) == List(10, 9, 7, 4, 0)
B

тип элементов в результирующей коллекции

That

фактический тип результирующей коллекции

z

начальное значение

op

бинарный оператор, применяемый к промежуточному результату и элементу

bf

явное значение класса CanBuildFrom, определяющее класс результата That на основе текущего типа представления Repr и нового типа элемента B.

returns

коллекция с промежуточными результатами

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
TraversableLike → GenTraversableLike
Аннотации
@migration
Миграция

(Изменено в версии 2.9.0) Поведение scanRight изменилось. Предыдущее поведение может быть воспроизведено с помощью scanRight.reverse.

def seq: collection.Iterable[A]

Версия этой коллекции со всеми операциями, реализованными последовательно (т.е. в однопоточном режиме).

Этот метод возвращает ссылку на эту коллекцию. В параллельных коллекциях он переопределён для возврата последовательной реализации этой коллекции. В обоих случаях сложность равна O(1).

returns

последовательный вид коллекции.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
Iterable → GenIterable → Traversable → GenTraversable → Parallelizable → TraversableOnce → GenTraversableOnce

def size: Int

Размер этой итерируемой коллекции.

Примечание: не завершается для коллекций бесконечного размера.

returns

количество элементов в этой итерируемой коллекции.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
TraversableOnce → GenTraversableOnce

def slice(from: Int, until: Int): collection.Iterable[A]

Выбирает интервал элементов. Результирующая коллекция состоит из всех элементов x, удовлетворяющих условию:

from <= indexOf(x) < until

Примечание: может возвращать разные результаты при разных запусках, если тип базовой коллекции не упорядочен.

returns

итерируемая коллекция, содержащая элементы, большие или равные индексу from, и не превосходящие индекс until этой итерируемой коллекции.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
IterableLike → TraversableLike → GenTraversableLike

def sliding(size: Int, step: Int): collection.Iterator[collection.Iterable[A]]

Группирует элементы в блоки фиксированного размера, пропуская «скользящее окно» по ним (в отличие от разбиения на части, как это делается в grouped).

size

количество элементов в группе

step

расстояние между первыми элементами последовательных групп

returns

Итератор, генерирующий итерируемые коллекции размера size, за исключением последнего элемента (который может быть единственным элементом), который будет усечён, если оставшихся элементов для группировки меньше, чем size.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Definition Classes
IterableLike
См. также

scala.collection.Iterator, метод sliding

def sliding(size: Int): collection.Iterator[collection.Iterable[A]]

Группирует элементы в блоки фиксированного размера, пропуская «скользящее окно» по ним (в отличие от разбиения на части, как это делается в grouped). Шаг «скользящего окна» установлен в единицу.

size

количество элементов в группе

returns

Итератор, генерирующий итерируемые коллекции размера size, за исключением последнего элемента (который может быть единственным элементом), который будет усечён, если оставшихся элементов для группировки меньше, чем size.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Definition Classes
IterableLike
См. также

scala.collection.Iterator, метод sliding

def span(p: (A) ⇒ Boolean): (collection.Iterable[A], collection.Iterable[A])

Разделяет эту итерируемую коллекцию на пару префикс/суффикс в соответствии с предикатом.

Примечание: c span p эквивалентно (но, возможно, более эффективно, чем) (c takeWhile p, c dropWhile p), при условии, что вычисление предиката p не вызывает побочных эффектов.

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

returns

пара, состоящая из самого длинного префикса этой итерируемой коллекции, элементы которой удовлетворяют p, и остальной части этой итерируемой коллекции.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike

def splitAt(n: Int): (collection.Iterable[A], collection.Iterable[A])

Разделяет эту итерируемую коллекцию на две части в заданной позиции. Примечание: c splitAt n эквивалентно (но, возможно, более эффективно, чем) (c take n, c drop n).

Примечание: может возвращать разные результаты для разных запусков, если тип базовой коллекции не упорядочен.

n

позиция разделения.

returns

пара итерируемых коллекций, состоящих из первых n элементов этой итерируемой коллекции и других элементов.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike

def stringPrefix: String

Определяет префикс представления этого объекта.

returns

представление в виде строки, которое начинается с результата toString, применённого к этой итерируемой коллекции. По умолчанию строковый префикс — просто имя класса коллекции — итерируемая коллекция.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Definition Classes
TraversableLike → GenTraversableLike

def sum: A

[use case]

Суммирует элементы этой коллекции.

returns

сумма всех элементов в этом варианте чисел типа Int. Вместо Int, может быть использован любой другой тип T с неявной Numeric[T] реализацией в качестве типа элемента варианта и как типа результата sum. Примерами таких типов являются: Long, Float, Double, BigInt.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Definition Classes
TraversableOnce → GenTraversableOnce
Полная подпись

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

Definition Classes
AnyRef

def tail: collection.Iterable[A]

Выбирает все элементы, кроме первого.

Примечание: могут возвращаться разные результаты при разных запусках, если тип базового набора не упорядочен.

возвращает

наборы элементов, содержащие все элементы этого набора, за исключением первого.

Неявный
Этот член добавлен с помощью неявного преобразования из Option[A] в Iterable[A], выполненного методом option2Iterable в scala.Option.
Классы определений
TraversableLike → GenTraversableLike
Исключения

java.lang.UnsupportedOperationException, если набор пуст.

def tails: collection.Iterator[collection.Iterable[A]]

Итерируется по хвостам этого набора. Первое значение будет этим набором, а последнее — пустым набором, а промежуточные значения будут результатами последовательных применений tail.

возвращает

итератор по всем хвостам этого набора

Неявный
Этот член добавлен с помощью неявного преобразования из Option[A] в Iterable[A], выполненного методом option2Iterable в scala.Option.
Классы определений
TraversableLike
Пример:

    List(1,2,3).tails = Iterator(List(1,2,3), List(2,3), List(3), Nil)

def take(n: Int): collection.Iterable[A]

Выбирает первые n элементов.

Примечание: могут возвращаться разные результаты при разных запусках, если тип базового набора не упорядочен.

n

количество элементов, которые нужно взять из этого набора.

возвращает

набор, содержащий только первые n элементов этого набора, или же весь набор, если в нем меньше n элементов. Если n отрицательно, возвращается пустой набор.

Неявный
Этот член добавлен с помощью неявного преобразования из Option[A] в Iterable[A], выполненного методом option2Iterable в scala.Option.
Классы определений
IterableLike → TraversableLike → GenTraversableLike

def takeRight(n: Int): collection.Iterable[A]

Выбирает последние n элементов.

Примечание: могут возвращаться разные результаты при разных запусках, если тип базового набора не упорядочен.

n

количество элементов, которые нужно взять

возвращает

набор, содержащий только последние n элементов этого набора, или же весь набор, если в нем меньше n элементов.

Неявный
Этот член добавлен с помощью неявного преобразования из Option[A] в Iterable[A], выполненного методом option2Iterable в scala.Option.
Классы определений
IterableLike

def takeWhile(p: (A) ⇒ Boolean): collection.Iterable[A]

Берет самый длинный префикс элементов, удовлетворяющих предикату.

Примечание: могут возвращаться разные результаты при разных запусках, если тип базового набора не упорядочен.

возвращает

самый длинный префикс этого набора, элементы которого удовлетворяют предикату p.

Неявный
Этот член добавлен с помощью неявного преобразования из Option[A] в Iterable[A], выполненного методом option2Iterable в scala.Option.
Классы определений
IterableLike → TraversableLike → GenTraversableLike

def to[Col[_]]: Col[A]

[use case]

Преобразует этот вариант в другой, копируя все элементы.

Col

Тип коллекции, которую нужно создать.

возвращает

новая коллекция, содержащая все элементы этого варианта.

Неявный
Этот член добавлен с помощью неявного преобразования из Option[A] в Iterable[A], выполненного методом option2Iterable в scala.Option.
Классы определений
TraversableLike → TraversableOnce → GenTraversableOnce
Полная сигнатура

def toArray: Array[A]

[случай использования]

Преобразует этот параметр в массив.

возвращает

массив, содержащий все элементы этого параметра. Для типа элемента этого параметра должен быть доступен ClassTag.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Определяющие классы
TraversableOnce → GenTraversableOnce
Полная сигнатура

def toBuffer[B >: A]: Buffer[B]

Использует содержимое этого итерируемого набора коллекций для создания нового изменяемого буфера.

Примечание: не будет завершаться для коллекций бесконечного размера.

возвращает

буфер, содержащий все элементы этого итерируемого набора коллекций.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Определяющие классы
TraversableOnce → GenTraversableOnce

def toIndexedSeq: collection.immutable.IndexedSeq[A]

Преобразует этот итерируемый набор коллекций в индексированную последовательность.

Примечание: не будет завершаться для коллекций бесконечного размера.

возвращает

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

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Определяющие классы
TraversableOnce → GenTraversableOnce

def toIterable: collection.Iterable[A]

Возвращает этот итерируемый набор коллекций как итерируемый набор коллекций.

Новая коллекция не будет построена; ленивые коллекции останутся ленивыми.

Примечание: не будет завершаться для коллекций бесконечного размера.

возвращает

коллекцию, содержащую все элементы этого итерируемого набора коллекций.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Определяющие классы
IterableLike → TraversableOnce → GenTraversableOnce

def toIterator: collection.Iterator[A]

Возвращает итератор над элементами в этом итерируемом наборе коллекций. Возвращает тот же результат, что и iterator.

Примечание: не будет завершаться для коллекций бесконечного размера.

возвращает

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

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A], выполненным методом option2Iterable в scala.Option.
Определяющие классы
IterableLike → TraversableLike → GenTraversableOnce
Аннотации
@deprecatedOverriding( message = ... , since = "2.11.0" )

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)
}
right

выражение для оценки и возврата, если оно пустое

Аннотации
@inline()
См. также

toRight

def toList: List[A]

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

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

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

def toMap[T, U]: Map[T, U]

[использование]

Преобразует этот параметр в карту. Этот метод недоступен, если элементы не являются членами Tuple2, каждая пара ((T, U)) становится парой ключ-значение в карте. Повторные ключи будут перезаписываться последующими ключами: если это неупорядоченный набор, то какой ключ находится в результирующей карте не определено.

возвращает

карта типа immutable.Map[T, U] содержащая все пары ключ/значение типа (T, U) этого параметра.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
TraversableOnce → GenTraversableOnce
Полная сигнатура

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)
}
left

выражение для вычисления и возврата, если это пусто

Аннотации
@inline()
См. также

toLeft

def toSeq: collection.Seq[A]

Преобразует это итерируемое множество в последовательность. Как и toIterable, ленивое в этом реализации по умолчанию, так как этот TraversableOnce может быть ленивым и невычисленным.

Примечание: не завершит работу для бесконечных наборов.

возвращает

последовательность, содержащая все элементы этого итерируемого множества.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
TraversableOnce → GenTraversableOnce

def toSet[B >: A]: Set[B]

Преобразует это итерируемое множество в множество.

Примечание: не завершит работу для бесконечных наборов.

возвращает

множество, содержащее все элементы этого итерируемого множества.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
TraversableOnce → GenTraversableOnce

def toStream: collection.immutable.Stream[A]

Преобразует это итерируемое множество в поток.

возвращает

поток, содержащий все элементы этого итерируемого множества.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
IterableLike → TraversableLike → GenTraversableOnce

def toString(): String

Создает строковое представление этого объекта. По умолчанию представление зависит от платформы. На платформе Java это конкатенация имени класса, "@" и хэш-кода объекта в шестнадцатеричном формате.

возвращает

строковое представление объекта.

Определяющие классы
AnyRef → Any

def toTraversable: collection.Traversable[A]

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

Примечание: не завершит работу для бесконечных наборов.

возвращает

Traversable, содержащий все элементы этого итерируемого множества.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
TraversableLike → TraversableOnce → GenTraversableOnce
Аннотации
@deprecatedOverriding( message = ... , since = "2.11.0" )

def toVector: Vector[A]

Преобразует этот итерируемый набор в вектор.

Примечание: не будет завершаться для коллекций бесконечного размера.

returns

вектор, содержащий все элементы этого итерируемого набора.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] при выполнении метода option2Iterable в scala.Option.
Классы определений
TraversableOnce → GenTraversableOnce

def transpose[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[B]): collection.Iterable[collection.Iterable[B]]

Транспонирует этот итерируемый набор перебираемых наборов в итерируемый набор итерируемых наборов.

Тип результирующей коллекции будет определяться статическим типом итерируемой коллекции. Например:

val xs = List(
           Set(1, 2, 3),
           Set(4, 5, 6)).transpose
// xs == List(
//         List(1, 4),
//         List(2, 5),
//         List(3, 6))

val ys = Vector(
           List(1, 2, 3),
           List(4, 5, 6)).transpose
// ys == Vector(
//         Vector(1, 4),
//         Vector(2, 5),
//         Vector(3, 6))
B

тип элементов каждой перебираемой коллекции.

asTraversable

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

returns

двумерная итерируемая коллекция итерируемых коллекций, в которой n-я строка — это n-й столбец этого итерируемого набора.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] при выполнении метода option2Iterable в scala.Option.
Классы определений
GenericTraversableTemplate
Аннотации
@migration
Миграция

(Изменено в версии 2.9.0) transpose вызывает IllegalArgumentException , если коллекции не имеют одинакового размера.

Исключения

IllegalArgumentException если все коллекции в этом итерируемом наборе не имеют одинаковый размер.

def unzip[A1, A2](implicit asPair: (A) ⇒ (A1, A2)): (collection.Iterable[A1], collection.Iterable[A2])

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

val xs = Iterable(
           (1, "one"),
           (2, "two"),
           (3, "three")).unzip
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

тип первой половины пар элементов

A2

тип второй половины пар элементов

asPair

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

returns

пара итерируемых коллекций, содержащая первую и, соответственно, вторую половину каждой пары элементов этого итерируемого набора.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] при выполнении метода option2Iterable в scala.Option.
Классы определений
GenericTraversableTemplate

def unzip3[A1, A2, A3](implicit asTriple: (A) ⇒ (A1, A2, A3)): (collection.Iterable[A1], collection.Iterable[A2], collection.Iterable[A3])

Преобразует этот итерируемый набор троек в три набора первого, второго и третьего элемента каждой тройки.

val xs = Iterable(
           (1, "one", '1'),
           (2, "two", '2'),
           (3, "three", '3')).unzip3
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three),
//        Iterable(1, 2, 3))
A1

тип первого члена троек элементов

A2

тип второго члена троек элементов

A3

тип третьего члена троек элементов

asTriple

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

returns

тройка итерируемых коллекций, содержащая первый, второй и, соответственно, третий член каждой тройки элементов этого итерируемого набора.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] при выполнении метода option2Iterable в scala.Option.
Классы определений
GenericTraversableTemplate

def view(from: Int, until: Int): IterableView[A, collection.Iterable[A]]

Создаёт нестрогую (нестрогий вид) представлением среза этого итерируемого набора.

Примечание: разница между view и slice заключается в том, что view создаёт представление текущего итерируемого набора, тогда как slice создаёт новый итерируемый набор.

Примечание: view(from, to) эквивалентно view.slice(from, to)

Примечание: может возвращать разные результаты для разных запусков, если тип основного набора не является упорядоченным.

from

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

until

индекс элемента, следующего за представлением

returns

нестрогое представление среза этого итерируемого набора, начинающегося с индекса from и продолжающегося до (но не включая) индекса until.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
IterableLike → TraversableLike

def view: IterableView[A, collection.Iterable[A]]

Создаёт нестрогое представление этого итерируемого набора.

returns

нестрогое представление этого итерируемого набора.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
IterableLike → TraversableLike

final def wait(): Unit

Определяющие классы
AnyRef
Аннотации
@throws( ... )

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

Определяющие классы
AnyRef
Аннотации
@throws( ... )

final def wait(arg0: Long): Unit

Определяющие классы
AnyRef
Аннотации
@throws( ... ) @native()

final def withFilter(p: (A) ⇒ Boolean): WithFilter

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

Аннотации
@inline()

def zip[B](that: GenIterable[B]): Option[(A, B)]

[use case]

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

B

тип второй половины возвращаемых пар

that

Итерируемый набор, предоставляющий вторую половину каждой результатной пары

returns

новый Option, содержащий пары, состоящие из соответствующих элементов этого Option и that. Длина возвращаемого набора равна минимуму длин этого Option и that.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Определяющие классы
IterableLike → GenIterableLike
Полная сигнатура

def zipAll[B](that: collection.Iterable[B], thisElem: A, thatElem: B): Option[(A, B)]

[use case]

Возвращает опцию, образованную из этой опции и другой итерируемой коллекции, комбинируя соответствующие элементы в парах. Если одна из двух коллекций короче другой, используются заполнители для расширения более короткой коллекции до длины более длинной.

B

тип второй половины возвращаемых пар

that

Итерируемая коллекция, предоставляющая вторую половину каждой пары результата

thisElem

элемент, используемый для заполнения результата, если эта опция короче, чем that.

thatElem

элемент, используемый для заполнения результата, если that короче, чем эта опция.

returns

новая опция, содержащая пары, состоящие из соответствующих элементов этой опции и that. Длина возвращаемой коллекции равна максимальной из длин этой опции и that. Если эта опция короче, чем that, значения thisElem используются для заполнения результата. Если that короче, чем эта опция, значения thatElem используются для заполнения результата.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] в методе option2Iterable в scala.Option.
Определяющие классы
IterableLike → GenIterableLike
Полная сигнатура

def zipWithIndex: Option[(A, Int)]

[use case]

Объединяет эту опцию с ее индексами.

returns

Новая опция, содержащая пары, состоящие из всех элементов этой опции, соединённых с их индексом. Индексы начинаются с 0.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] в методе option2Iterable в scala.Option.
Определяющие классы
IterableLike → GenIterableLike
Полная сигнатура
Пример:

    List("a", "b", "c").zipWithIndex = List(("a", 0), ("b", 1), ("c", 2))

def →[B](y: B): (Option[A], B)

Неявный
Этот член добавлен неявным преобразованием из Option[A] в ArrowAssoc[Option[A]] в методе ArrowAssoc в scala.Predef.
Определяющие классы
ArrowAssoc

Члены значения неявного типа с затенением

def canEqual(that: Any): Boolean

Метод, вызываемый из методов равенства, чтобы пользовательские подклассы могли отказываться от равенства с другими коллекциями того же типа.

that

Объект, с которым эта итерируемая коллекция должна быть сравнена

returns

true, если эта итерируемая коллекция может потенциально быть равной that, false в противном случае. Тест учитывает только типы объектов во время выполнения, но игнорирует их элементы.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеняется одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).canEqual(that)
Definition Classes
IterableLike → Equals

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

[use case]

Создает новую коллекцию, применяя частичную функцию ко всем элементам этого варианта, для которых функция определена.

B

тип элементов возвращаемой коллекции.

pf

частичная функция, которая фильтрует и отображает вариант.

returns

новый вариант, полученный путем применения данной частичной функции pf к каждому элементу, для которого она определена, и сбора результатов. Порядок элементов сохраняется.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеняется одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).collect(pf)
Definition Classes
TraversableLike → GenTraversableLike
Полная сигнатура

def exists(p: (A) ⇒ Boolean): Boolean

Проверяет, выполняется ли предикат по крайней мере для одного элемента этой итерируемой коллекции.

Примечание: может не завершиться для коллекций бесконечного размера.

p

предикат, используемый для проверки элементов.

returns

false если эта итерируемая коллекция пуста, в противном случае true если данный предикат p выполняется для некоторых элементов этой итерируемой коллекции, в противном случае false

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеняется одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).exists(p)
Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

def filter(p: (A) ⇒ Boolean): collection.Iterable[A]

Выбирает все элементы этой итерируемой коллекции, которые удовлетворяют предикату.

p

предикат, используемый для проверки элементов.

returns

новая итерируемая коллекция, состоящая из всех элементов этой итерируемой коллекции, которые удовлетворяют заданному предикату p. Порядок элементов сохраняется.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеняется одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).filter(p)
Definition Classes
TraversableLike → GenTraversableLike

def filterNot(p: (A) ⇒ Boolean): collection.Iterable[A]

Выбирает все элементы этой итерируемой коллекции, которые не удовлетворяют предикату.

p

предикат, используемый для проверки элементов.

returns

новая итерируемая коллекция, состоящая из всех элементов этой итерируемой коллекции, которые не удовлетворяют заданному предикату p. Порядок элементов сохраняется.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеняется одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).filterNot(p)
Definition Classes
TraversableLike → GenTraversableLike

def flatMap[B](f: (A) ⇒ GenTraversableOnce[B]): Option[B]

[use case]

Создаёт новую коллекцию, применяя функцию ко всем элементам этого варианта и используя элементы полученных коллекций.

Например:

def getWords(lines: Seq[String]): Seq[String] = lines flatMap (line => line split "\\W+")

Тип результирующей коллекции определяется статическим типом варианта. Иногда это может привести к неожиданным результатам. Например:

// lettersOf will return a Seq[Char] of likely repeated letters, instead of a Set
def lettersOf(words: Seq[String]) = words flatMap (word => word.toSet)

// lettersOf will return a Set[Char], not a Seq
def lettersOf(words: Seq[String]) = words.toSet flatMap (word => word.toSeq)

// xs will be an Iterable[Int]
val xs = Map("a" -> List(11,111), "b" -> List(22,222)).flatMap(_._2)

// ys will be a Map[Int, Int]
val ys = Map("a" -> List(1 -> 11,1 -> 111), "b" -> List(2 -> 22,2 -> 222)).flatMap(_._2)
B

тип элементов возвращаемой коллекции.

f

функция, применяемая к каждому элементу.

returns

новый вариант, полученный в результате применения заданной функции, возвращающей коллекцию f к каждому элементу этого варианта и конкатенации результатов.

Implicit
Этот член добавляется неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Shadowing
Этот неявный унаследованный член скрыт одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(option: Iterable[A]).flatMap(f)
Definition Classes
TraversableLike → GenTraversableLike → FilterMonadic
Полная сигнатура

def flatten[B]: Option[B]

[use case]

Преобразует этот вариант коллекций traversable в вариант, образованный элементами этих коллекций traversable.

Тип результирующей коллекции будет определяться статическим типом варианта. Например:

val xs = List(
           Set(1, 2, 3),
           Set(1, 2, 3)
         ).flatten
// xs == List(1, 2, 3, 1, 2, 3)

val ys = Set(
           List(1, 2, 3),
           List(3, 2, 1)
         ).flatten
// ys == Set(1, 2, 3)
B

тип элементов каждой коллекции traversable.

returns

новый вариант, полученный путём конкатенации всех вариантов элементов.

Implicit
Этот член добавляется неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Shadowing
Этот неявный унаследованный член скрыт одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(option: Iterable[A]).flatten
Definition Classes
GenericTraversableTemplate
Полная сигнатура

def fold[A1 >: A](z: A1)(op: (A1, A1) ⇒ A1): A1

Выполняет свёртку элементов этой итерируемой коллекции с использованием указанного ассоциативного бинарного оператора.

Порядок выполнения операций над элементами не определён и может быть не детерминированным.

Примечание: для бесконечных коллекций не завершается.

A1

параметр типа для бинарного оператора, надтипа A.

z

нейтральный элемент для операции свёртки; может добавляться к результату произвольное количество раз и не должен изменять результат (например, Nil для конкатенации списков, 0 для сложения или 1 для умножения).

op

бинарный оператор, который должен быть ассоциативным.

returns

результат применения оператора свёртки op между всеми элементами и z, или z если эта итерируемая коллекция пуста.

Implicit
Этот член добавляется неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Shadowing
Этот неявный унаследованный член скрыт одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(option: Iterable[A]).fold(z)(op)
Definition Classes
TraversableOnce → GenTraversableOnce

def forall(p: (A) ⇒ Boolean): Boolean

Проверяет, выполняется ли предикат для всех элементов этой итерируемой коллекции.

Примечание: для бесконечных коллекций может не завершиться.

p

предикат, используемый для проверки элементов.

returns

true если эта итерируемая коллекция пуста или заданный предикат p выполняется для всех элементов этой итерируемой коллекции, в противном случае false.

Implicit
Этот член добавляется неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Shadowing
Этот неявный унаследованный член скрыт одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(option: Iterable[A]).forall(p)
Definition Classes
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

def foreach(f: (A) ⇒ Unit): Unit

[use case]

Применяет функцию f ко всем элементам этого параметра.

Примечание: этот метод лежит в основе реализации большинства других операций по обработке коллекции. Подклассы должны переопределять этот метод, если существует более эффективный вариант реализации.

f

функция, применяемая к каждому элементу для побочного эффекта. Результат функции f игнорируется.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеневается одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).foreach(f)
Определяющие классы
IterableLike → TraversableLike → GenTraversableLike → TraversableOnce → GenTraversableOnce → FilterMonadic
Полная сигнатура

def isEmpty: Boolean

Проверяет, пуста ли эта итерируемая коллекция.

возвращает

true если итерируемая коллекция не содержит элементов, false в противном случае.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеневается одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).isEmpty
Определяющие классы
IterableLike → TraversableLike → TraversableOnce → GenTraversableOnce

def iterator: collection.Iterator[A]

Создаёт новый итератор по всем элементам, содержащимся в этом итерируемом объекте.

возвращает

новый итератор

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеневается одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).iterator
Определяющие классы
IterableLike → GenIterableLike

def map[B](f: (A) ⇒ B): Option[B]

[use case]

Создаёт новую коллекцию, применяя функцию ко всем элементам этого параметра.

B

тип элементов возвращаемой коллекции.

f

функция, применяемая к каждому элементу.

возвращает

новый параметр, полученный путём применения заданной функции f к каждому элементу этого параметра и сборке результатов.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеневается одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).map(f)
Определяющие классы
TraversableLike → GenTraversableLike → FilterMonadic
Полная сигнатура

def nonEmpty: Boolean

Проверяет, не пуста ли итерируемая коллекция.

возвращает

true если итерируемая коллекция содержит по меньшей мере один элемент, false в противном случае.

Неявный
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявный унаследованный член затеневается одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать приведение типа:
(option: Iterable[A]).nonEmpty
Определяющие классы
TraversableOnce → GenTraversableOnce

def toList: List[A]

Преобразует это итерируемое множество в список.

Примечание: не будет завершаться для бесконечных множеств.

returns

список, содержащий все элементы этого итерируемого множества.

Неявное
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявно унаследованный член затенён одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(option: Iterable[A]).toList
Классы определений
TraversableOnce → GenTraversableOnce

def toString(): String

Преобразует это итерируемое множество в строку.

returns

строковое представление этого множества. По умолчанию эта строка состоит из stringPrefix этого итерируемого множества, за которым следуют все элементы, разделённые запятыми и заключённые в скобки.

Неявное
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявно унаследованный член затенён одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(option: Iterable[A]).toString()
Классы определений
TraversableLike → Any

def withFilter(p: (A) ⇒ Boolean): FilterMonadic[A, collection.Iterable[A]]

Создаёт нестрогий фильтр этого итерируемого множества.

Примечание: разница между c filter p и c withFilter p в том, что первый создаёт новое множество, а второй только ограничивает область последующих map, flatMap, foreach, и withFilter операций.

Примечание: может возвращать разные результаты при разных запусках, если тип базового множества не упорядочен.

p

предикат, используемый для проверки элементов.

returns

объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этого итерируемого множества, которые удовлетворяют предикату p.

Неявное
Этот член добавлен неявным преобразованием из Option[A] в Iterable[A] с помощью метода option2Iterable в scala.Option.
Затенение
Этот неявно унаследованный член затенён одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать привязку типа:
(option: Iterable[A]).withFilter(p)
Классы определений
TraversableLike → FilterMonadic

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/Option.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API