Spec-Zone.ru › Scala 2.13 Library

Класс scala.collection.immutable.AbstractMap

абстрактный класс AbstractMap[K, +V] extends collection.AbstractMap[K, V] with Map[K, V]

Явное создание экземпляра Map для уменьшения размера файла класса в подклассах.

Аннотации
@SerialVersionUID()
Источник
Map.scala
Линейные надтипы
Map[K, V], MapOps[K, V, Map, Map[K, V]], Iterable[(K, V)], collection.AbstractMap[K, V], collection.Map[K, V], Equals, MapFactoryDefaults[K, V, [x, y]Map[x, y], [x]Iterable[x]], collection.MapOps[K, V, [_, _]Map[_, _], Map[K, V]], PartialFunction[K, V], (K) => V, AbstractIterable[(K, V)], collection.Iterable[(K, V)], IterableFactoryDefaults[(K, V), [x]Iterable[x]], IterableOps[(K, V), [_]Iterable[_], Map[K, V]], IterableOnceOps[(K, V), [_]Iterable[_], Map[K, V]], IterableOnce[(K, V)], AnyRef, Any
Известные подклассы
HashMap, IntMap, ListMap, LongMap, Map1, Map2, Map3, Map4, WithDefault, WithDefault, TreeMap, TreeSeqMap, VectorMap

Конструкторы экземпляров

новый AbstractMap()

Члены типов

трайт GenKeySet extends AnyRef

Обобщённый трайт, используемый реализациями набора ключей

Атрибуты
protected
Классы определения
MapOps

класс KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

Реализующий класс множества, возвращаемого методом keySet.

Атрибуты
protected
Классы определения
MapOps

класс ImmutableKeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

Реализующий класс множества, возвращаемого методом keySet

Атрибуты
protected
Классы определения
MapOps

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

абстрактный def get(key: K): Option[V]

Возвращает значение, связанное с ключом.

key

значение ключа

возвращает

объект Option, содержащий значение, связанное с key, или None, если оно отсутствует.

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

абстрактный def iterator: Iterator[(K, V)]

Итератор может быть использован только один раз

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

абстрактный def removed(key: K): Map[K, V]

Удаляет ключ из этого карты, возвращая новую карту.

key

ключ для удаления

возвращает

новая карта без связи для key

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

абстрактный def updated[V1 >: V](key: K, value: V1): Map[K, V1]

Создаёт новую карту, обновлённую этой картой с заданной парой ключ/значение.

V1

тип добавленного значения

key

ключ

value

значение

возвращает

Новая карта с добавленной новой связью ключ/значение в эту карту. <неверная аннотация inheritdoc>

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

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

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 +[V1 >: V](kv: (K, V1)): Map[K, V1]

Псевдоним для updated

V1

тип значения в паре ключ/значение.

kv

пара ключ/значение.

returns

Новый словарь с добавленной новой связью в этот словарь.

Definition Classes
MapOps → MapOps

def ++[V2 >: V](xs: IterableOnce[(K, V2)]): Map[K, V2]

Псевдоним для concat

Definition Classes
MapOps

final def ++[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

Псевдоним для concat

Definition Classes
IterableOps
Annotations
@inline()

final def -(key: K): Map[K, V]

Псевдоним для removed

Definition Classes
MapOps
Annotations
@inline()

final def --(keys: IterableOnce[K]): Map[K, V]

Псевдоним для removedAll

Definition Classes
MapOps → MapOps
Annotations
@inline()

def ->[B](y: B): (AbstractMap[K, V], B)

Неявный
Этот член добавлен неявным преобразованием из AbstractMap[K, V] вArrowAssoc[AbstractMap[K, V]] производимым методом ArrowAssoc в scala.Predef.Это преобразование будет происходить только если V является подклассом Option[Nothing] (V <: Option[Nothing]).
Definition Classes
ArrowAssoc
Annotations
@inline()

final def ==(arg0: Any): Boolean

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

возвращает

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

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

def addString(sb: mutable.StringBuilder, start: String, sep: String, end: String): mutable.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)
start

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

sep

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

end

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

возвращает

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

Классы-определения
MapOps → IterableOnceOps

final def addString(b: mutable.StringBuilder): mutable.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, в который были добавлены элементы.

Классы-определения
IterableOnceOps
Аннотации
@inline()

final def addString(b: mutable.StringBuilder, sep: String): mutable.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

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

возвращает

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

Классы-определения
IterableOnceOps
Аннотации
@inline()

def andThen[C](k: PartialFunction[V, C]): PartialFunction[K, C]

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

Обратите внимание, что вызов isDefinedAt на результирующей частичной функции может применить первую частичную функцию и выполнить её побочные эффекты. Рекомендуется использовать applyOrElse вместо isDefinedAt / apply для повышения эффективности.

C

тип результата функции преобразования.

k

функция преобразования

возвращает

частичная функция с областью определения данной частичной функции, суженная другой частичной функцией, которая отображает аргументы x в k(this(x)).

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

def andThen[C](k: (V) => C): PartialFunction[K, C]

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

Если тип времени выполнения функции является PartialFunction, то используется другой метод andThen (обратите внимание на его предостережения).

C

тип результата функции преобразования.

k

функция преобразования

возвращает

частичная функция с областью определения данной частичной функции, возможно суженной указанной функцией, которая отображает аргументы x в k(this(x)).

Классы-определения
PartialFunction → Function1

def apply(key: K): V

Получает значение, связанное с заданным ключом. Этот метод вызывает метод default карты, если нет соответствия между заданным ключом и значением. Если не переопределено, метод default вызывает исключение NoSuchElementException.

ключ

ключ

возвращает

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

Классы-определения
MapOps → Function1
Аннотации
@throws(scala.this.throws.<init>$default$1[NoSuchElementException])

def applyOrElse[K1 <: K, V1 >: V](x: K1, default: (K1) => V1): V1

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

Обратите внимание, что выражение pf.applyOrElse(x, default) эквивалентно

if(pf isDefinedAt x) pf(x) else default(x)

за исключением того, что метод applyOrElse может быть реализован более эффективно. Для всех частичных функций-литералов компилятор генерирует реализацию applyOrElse, которая избегает двойного вычисления соответствия с шаблонами и условий. Это делает applyOrElse основой для эффективной реализации многих операций и сценариев, таких как:

    объединение частичных функций в цепочки orElse/andThen не приводит к избыточному вычислению apply/isDefinedAt lift и unlift не вычисляют исходные функции дважды при каждом вызове runWith позволяет эффективно объединять частичные функции в императивном стиле с условными действиями

Для классов частичных функций, не являющихся литералами, с нетривиальным методом isDefinedAt, рекомендуется переопределить applyOrElse с пользовательской реализацией, которая избегает двойного вычисления isDefinedAt. Это может привести к лучшей производительности и более предсказуемому поведению с точки зрения побочных эффектов.

x

аргумент функции

default

функция по умолчанию

возвращает

результат применения этой функции или функции по умолчанию.

Классы-определения
MapOps → PartialFunction
С тех пор

2.10

final def asInstanceOf[T0]: T0

Преобразует объект-получатель к типу T0.

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

возвращает

объект-получатель.

Классы-определения
Any
Исключения

ClassCastException, если объект-получатель не является экземпляром стирания типа T0.

def canEqual(that: Any): Boolean

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

that

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

возвращает

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

Классы-определения
Map → Equals

def className: String

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

Рекомендуется возвращать имя конкретного типа коллекции, но не подклассы реализации. Например, для ListMap этот метод должен возвращать "ListMap", а не "Map" (супертип) или "Node" (подкласс реализации).

По умолчанию возвращает "Iterable". Переопределено для основных типов коллекций "Seq", "IndexedSeq", "LinearSeq", "Buffer", "Set", "Map", "SortedSet", "SortedMap" и "View".

возвращает

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

Атрибуты
protected[this]
Классы-определения
Iterable

def clone(): AnyRef

Создает копию объекта-получателя.

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

возвращает

копию объекта-получателя.

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

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

final def coll: AbstractMap.this.type

возвращает

Эта коллекция в виде C.

Атрибуты
protected
Классы-определения
Iterable → IterableOps

def collect[K2, V2](pf: PartialFunction[(K, V), (K2, V2)]): Map[K2, V2]

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

K2

тип ключа возвращаемой карты.

V2

тип значения возвращаемой карты.

pf

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

returns

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

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

def collect[B](pf: PartialFunction[(K, V), B]): Iterable[B]

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

B

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

pf

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

returns

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

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

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

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

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

pf

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

returns

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

Определяющие классы
IterableOnceOps
Пример:

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

def compose[R](k: PartialFunction[R, K]): PartialFunction[R, V]

Комбинирует другую частичную функцию k с этой частичной функцией так, что эта частичная функция применяется к результатам k.

Обратите внимание, что вызов isDefinedAt для результирующей частичной функции может применить первую частичную функцию и выполнить ее побочный эффект. Настоятельно рекомендуется вызывать applyOrElse вместо isDefinedAt / apply для повышения эффективности.

R

тип параметра функции преобразования.

k

функция преобразования

returns

частичная функция с областью определения другой частичной функции, суженной этой частичной функцией, которая отображает аргументы x на this(k(x)).

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

def compose[A](g: (A) => K): (A) => V

Комбинирует два экземпляра Function1 в новый Function1, при этом эта функция применяется последней.

A

тип, к которому может быть применена функция g

g

функция A => T1

returns

новая функция f такая, что f(x) == apply(g(x))

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

def concat[V2 >: V](suffix: IterableOnce[(K, V2)]): Map[K, V2]

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

suffix

объект для добавления.

returns

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

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

def concat[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

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

B

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

suffix

объект для добавления.

returns

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

Definition Classes
IterableOps

def contains(key: K): Boolean

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

key

ключ

returns

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

Definition Classes
MapOps

def copyToArray[B >: (K, V)](xs: Array[B], start: Int, len: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start не более чем len элементами этой коллекции.

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

B

тип элементов массива.

xs

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

start

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

len

максимальное количество копируемых элементов.

returns

количество элементов, записанных в массив

Definition Classes
IterableOnceOps
Note

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

def copyToArray[B >: (K, V)](xs: Array[B], start: Int): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start значениями этой коллекции.

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

B

тип элементов массива.

xs

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

start

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

returns

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

Definition Classes
IterableOnceOps

def copyToArray[B >: (K, V)](xs: Array[B]): Int

Копирует элементы в массив, возвращая количество скопированных элементов.

Заполняет заданный массив xs начиная с индекса start значениями этой коллекции.

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

B

тип элементов массива.

xs

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

returns

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

Definition Classes
IterableOnceOps

def corresponds[B](that: IterableOnce[B])(p: ((K, V), B) => Boolean): Boolean

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

B

тип элементов that.

that

другая коллекция

p

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

returns

true , если обе коллекции имеют одинаковую длину, и p(x, y) является true для всех соответствующих элементов x этого итератора и y that, в противном случае false.

Definition Classes
IterableOnceOps

def count(p: ((K, V)) => Boolean): Int

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

p

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

returns

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

Definition Classes
IterableOnceOps

def default(key: K): V

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

key

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

Definition Classes
MapOps
Annotations
@throws(scala.this.throws.<init>$default$1[NoSuchElementException])
Exceptions thrown

def drop(n: Int): Map[K, V]

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

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

n

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def dropRight(n: Int): Map[K, V]

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

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

n

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

returns

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

Definition Classes
IterableOps

def dropWhile(p: ((K, V)) => Boolean): Map[K, V]

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def elementWise: ElementWiseExtractor[K, V]

Возвращает объект-экстрактор с методом unapplySeq, который извлекает каждый элемент данных последовательности.

Definition Classes
PartialFunction
Пример:
    val firstChar: String => Option[Char] = _.headOption
    
    Seq("foo", "bar", "baz") match {
      case firstChar.unlift.elementWise(c0, c1, c2) =>
        println(s"$c0, $c1, $c2") // Output: f, b, b
    }

def empty: Map[K, V]

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

returns

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

Definition Classes
MapFactoryDefaults → IterableOps

def ensuring(cond: (AbstractMap[K, V]) => Boolean, msg: => Any): AbstractMap[K, V]

Implicit
Этот член добавлен неявным преобразованием из AbstractMap[K, V] в Ensuring[AbstractMap[K, V]] с помощью метода Ensuring в scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (AbstractMap[K, V]) => Boolean): AbstractMap[K, V]

Неявное
Этот член добавлен неявным преобразованием из AbstractMap[K, V] в Ensuring[AbstractMap[K, V]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: Boolean, msg: => Any): AbstractMap[K, V]

Неявное
Этот член добавлен неявным преобразованием из AbstractMap[K, V] в Ensuring[AbstractMap[K, V]], выполненным методом Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: Boolean): AbstractMap[K, V]

Неявное
Этот член добавлен неявным преобразованием из AbstractMap[K, V] в Ensuring[AbstractMap[K, V]], выполненным методом 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(o: Any): Boolean

Универсальный метод равенства, определенный в AnyRef.

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

def exists(p: ((K, V)) => Boolean): Boolean

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

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

p

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

возвращает

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

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

def filter(pred: ((K, V)) => Boolean): Map[K, V]

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

возвращает

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

Определяющие классы
IterableOps → IterableOnceOps

def filterNot(pred: ((K, V)) => Boolean): Map[K, V]

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

pred

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

returns

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

Определяющие классы
IterableOps → IterableOnceOps

def finalize(): Unit

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

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

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

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

def find(p: ((K, V)) => Boolean): Option[(K, V)]

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

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

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

p

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

returns

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

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

def flatMap[K2, V2](f: ((K, V)) => IterableOnce[(K2, V2)]): Map[K2, V2]

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

f

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

returns

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

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

def flatMap[B](f: ((K, V)) => IterableOnce[B]): Iterable[B]

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

Например:

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: String) => 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 к каждому элементу этой итерируемой коллекции и конкатенации результатов.

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

def flatten[B](implicit asIterable: ((K, V)) => IterableOnce[B]): Iterable[B]

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

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

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

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

asIterable

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

returns

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

def fold[A1 >: (K, V)](z: A1)(op: (A1, A1) => A1): A1

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

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

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

A1

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

z

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

op

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

returns

результат применения оператора сложения op между всеми элементами и z, или z, если этот набор пуст.

Definition Classes
IterableOnceOps

def foldLeft[B](z: B)(op: (B, (K, V)) => B): B

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

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

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

B

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

z

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

op

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

returns

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

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

где x1, ..., xn — элементы этого набора. Возвращает z, если этот набор пуст.

Definition Classes
IterableOnceOps

def foldRight[B](z: B)(op: ((K, V), B) => B): B

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

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

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

B

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

z

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

op

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

returns

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

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

где x1, ..., xn — элементы этого набора. Возвращает z, если этот набор пуст.

Definition Classes
IterableOnceOps

def forall(p: ((K, V)) => Boolean): Boolean

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

def foreach[U](f: ((K, V)) => U): Unit

Применить f к каждому элементу для его побочных эффектов Примечание: параметр [U] необходим для помощи в выводе типов scalac.

Definition Classes
IterableOnceOps

def foreachEntry[U](f: (K, V) => U): Unit

Применить f к каждой паре ключ/значение для его побочных эффектов Примечание: параметр [U] необходим для помощи в выводе типов scalac.

Definition Classes
MapOps

def formatted(fmtstr: String): String

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

Implicit
Этот член добавляется неявным преобразованием из AbstractMap[K, V] вStringFormat[AbstractMap[K, V]] выполняемой методом StringFormat в scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def fromSpecific(coll: IterableOnce[(K, V)]): Map[K, V]

Определяет, как преобразовать заданную Iterable[A] в коллекцию типа C.

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

Атрибуты
protected
Классы-определения
MapFactoryDefaults → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод необходимо переопределить (в противном случае компилятор выдаст ошибку). В общем случае, когда C =:= CC[A], это можно сделать, добавив трейт IterableFactoryDefaults, который реализует метод с использованием iterableFactory.

,

Как свидетельствует аннотация @uncheckedVariance, использование этого метода может быть небезопасным. Однако, пока он вызывается с Iterable[A], полученным из коллекции this (как это происходит в реализациях операций, где мы используем View[A]), он безопасен.

final def getClass(): Class[_ <: AnyRef]

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

возвращает

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

Классы-определения
AnyRef → Any
Аннотации
@native()

def getOrElse[V1 >: V](key: K, default: => V1): V1

Возвращает значение, связанное с ключом, или значение по умолчанию, если ключ не содержится в карте.

V1

тип результата вычисления по умолчанию.

key

ключ.

default

вычисление, которое возвращает значение по умолчанию, если в карте нет связи для key.

возвращает

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

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

def groupBy[K](f: ((K, V)) => K): Map[K, Map[K, V]]

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

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

K

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

f

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

возвращает

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

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

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

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

def groupMap[K, B](key: ((K, V)) => K)(f: ((K, V)) => B): Map[K, Iterable[B]]

Разделяет эту итерируемую коллекцию на карту итерируемых коллекций в соответствии с функцией дискриминатора key Каждый элемент в группе преобразуется в значение типа B с помощью функции value.

Эквивалентно groupBy(key).mapValues(_.map(f)), но более эффективно.

case class User(name: String, age: Int)

def namesByAge(users: Seq[User]): Map[Int, Seq[String]] =
  users.groupMap(_.age)(_.name)

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

K

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

B

тип значений, возвращаемых функцией преобразования

key

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

f

функция преобразования элементов

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

def groupMapReduce[K, B](key: ((K, V)) => K)(f: ((K, V)) => B)(reduce: (B, B) => B): Map[K, B]

Разделяет эту итерируемую коллекцию на карты в соответствии с функцией-дискриминатором key. Все значения, имеющие одинаковый дискриминатор, затем преобразуются функцией value и затем сводятся к одному значению с помощью функции reduce.

Это эквивалентно groupBy(key).mapValues(_.map(f).reduce(reduce)), но более эффективно.

def occurrences[A](as: Seq[A]): Map[A, Int] =
  as.groupMapReduce(identity)(_ => 1)(_ + _)

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

Классы определений
IterableOps

def grouped(size: Int): Iterator[Map[K, V]]

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

size

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

возвращает

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

Классы определений
IterableOps
См. также

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

def hashCode(): Int

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

возвращает

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

Классы определений
Map → AnyRef → Any

def head: (K, V)

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

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

возвращает

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

Классы определений
IterableOps
Исключения

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

def headOption: Option[(K, V)]

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

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

возвращает

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

Классы определений
IterableOps

def init: Map[K, V]

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

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

Классы определений
IterableOps

def inits: Iterator[Map[K, V]]

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

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

возвращает

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

Классы определений
IterableOps
Пример:

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

def isDefinedAt(key: K): Boolean

Проверяет, содержит ли эта карта привязку для ключа. Этот метод, реализующий абстрактный метод тракта PartialFunction, эквивалентен contains.

key

ключ

возвращает

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

Классы определений
MapOps → PartialFunction

def isEmpty: Boolean

Проверяет, пуста ли коллекция.

Примечание: Реализации в подклассах, которые не являются повторно проходимыми, должны позаботиться о том, чтобы не потреблять никаких элементов при вызове isEmpty.

возвращает

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

Классы определений
IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

возвращает

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

Классы определений
Any

def isTraversableAgain: Boolean

Проверяет, может ли эта итерируемая коллекция многократно просматриваться. Всегда истинно для Iterable и ложно для Iterator, если не переопределено.

returns

true если она многократно просматриваема, false в противном случае.

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: IterableFactory[Iterable]

Компаньон-объект этой неизменяемой коллекции, предоставляющий различные методы фабрики.

Definition Classes
Iterable → Iterable → IterableOps
Note

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

def keySet: Set[K]

Собирает все ключи этой карты в множестве.

returns

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

Definition Classes
MapOps → MapOps

def keyStepper[S <: Stepper[_]](implicit shape: StepperShape[K, S]): S

Возвращает Stepper для ключей этой карты. См. метод stepper.

Definition Classes
MapOps

def keys: collection.Iterable[K]

Собирает все ключи этой карты в итерируемую коллекцию.

returns

ключи этой карты в виде итерируемого.

Definition Classes
MapOps

def keysIterator: Iterator[K]

Создает итератор для всех ключей.

returns

итератор по всем ключам.

Definition Classes
MapOps

def knownSize: Int

returns

Количество элементов в этой коллекции, если оно может быть вычислено быстро, иначе -1. Быстро обычно означает: Не требует обхода коллекции.

Definition Classes
IterableOnce

def last: (K, V)

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

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

returns

Последний элемент этой итерируемой коллекции.

Definition Classes
IterableOps
Exceptions thrown

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

def lastOption: Option[(K, V)]

Выбирает последний элемент (необязательно).

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

returns

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

Definition Classes
IterableOps

def lazyZip[B](that: collection.Iterable[B]): LazyZip2[(K, V), B, AbstractMap.this.type]

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

Вызовы lazyZip могут быть объединены, чтобы поддерживать более высокие арности (до 4) без затрат на построение и деконструкцию промежуточных кортежей.

val xs = List(1, 2, 3)
val res = (xs lazyZip xs lazyZip xs lazyZip xs).map((a, b, c, d) => a + b + c + d)
// res == List(4, 8, 12)
B

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

that

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

returns

декоратор LazyZip2, который позволяет выполнять строгие операции над лениво вычисляемыми парами или объединёнными вызовами lazyZip. Также поддерживается неявное преобразование в Iterable[(A, B)].

Definition Classes
Iterable

def lift: (K) => Option[V]

Преобразует эту частичную функцию в обычную функцию, возвращающую результат Option.

возвращает

функцию, которая принимает аргумент x к Some(this(x)), если this определено для x, и к None в противном случае.

Определяющие классы
PartialFunction
См. также

Function.unlift

def map[K2, V2](f: ((K, V)) => (K2, V2)): Map[K2, V2]

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

f

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

возвращает

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

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

def map[B](f: ((K, V)) => B): Iterable[B]

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

B

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

f

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

возвращает

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

def mapFactory: MapFactory[Map]

Компаньон-объект этой карты, предоставляющий различные методы фабрики.

Определяющие классы
Map → Map → MapOps
Примечание

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

final def mapFromIterable[K2, V2](it: collection.Iterable[(K2, V2)]): Map[K2, V2]

Аналогично fromIterable, но возвращает тип коллекции Map. Обратите внимание, что тип возвращаемого значения теперь CC[K2, V2].

Атрибуты
protected
Определяющие классы
MapOps
Аннотации
@inline()

def max[B >: (K, V)](implicit ord: math.Ordering[B]): (K, V)

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

B

Тип, по которому определено упорядочение.

ord

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

возвращает

наибольший элемент этой коллекции относительно упорядочения ord.

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

UnsupportedOperationException, если эта коллекция пуста.

def maxBy[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): (K, V)

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

B

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

f

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

cmp

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

возвращает

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

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

UnsupportedOperationException, если эта коллекция пуста.

def maxByOption[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): Option[(K, V)]

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

B

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

f

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

cmp

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

returns

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

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

def maxOption[B >: (K, V)](implicit ord: math.Ordering[B]): Option[(K, V)]

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

B

Тип, над которым определен порядок.

ord

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

returns

необязательное значение, содержащее наибольший элемент этой коллекции относительно порядка ord.

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

def min[B >: (K, V)](implicit ord: math.Ordering[B]): (K, V)

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

B

Тип, над которым определен порядок.

ord

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

returns

наименьший элемент этой коллекции относительно порядка ord.

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

def minBy[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): (K, V)

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

B

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

f

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

cmp

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

returns

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

def minByOption[B](f: ((K, V)) => B)(implicit cmp: math.Ordering[B]): Option[(K, V)]

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

B

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

f

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

cmp

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

returns

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

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

def minOption[B >: (K, V)](implicit ord: math.Ordering[B]): Option[(K, V)]

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

B

Тип, над которым определен порядок.

ord

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

returns

необязательное значение, содержащее наименьший элемент этой коллекции относительно порядка ord.

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

final def mkString: String

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

Делегирует вызов методу addString, который может быть переопределён.

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final def mkString(sep: String): String

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

Делегирует вызов методу addString, который может быть переопределён.

sep

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()
Пример:

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

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

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

Делегирует вызов методу addString, который может быть переопределён.

start

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

sep

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

end

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

returns

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

Definition Classes
IterableOnceOps
Пример:

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

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

def newSpecificBuilder: Builder[(K, V), Map[K, V]]

returns

строгий билдер для того же типа коллекции. Обратите внимание, что в случае ленивых коллекций (например, View или immutable.LazyList), реализация этого метода возможна, но полученный Builder нарушит ленивость. Поэтому операции предпочтительно реализовывать с помощью fromSpecific, а не с помощью этого метода.

Attributes
protected
Definition Classes
MapFactoryDefaults → IterableOps
Примечание

При реализации пользовательского типа коллекции и уточнении C до нового типа, этот метод должен быть переопределён (иначе компилятор выдаст ошибку). В общем случае, когда C =:= CC[A], это можно сделать, добавив трейт IterableFactoryDefaults, который реализует метод с использованием iterableFactory.

,

Как показано аннотацией @uncheckedVariance, использование этого метода может быть небезопасным. Однако, пока возвращаемый билдер заполняется только значениями A, взятыми из экземпляра this, он безопасен.

def nonEmpty: Boolean

Проверяет, не пуста ли коллекция.

returns

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

Definition Classes
IterableOnceOps
Annotations
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Примечание

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

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Примечание

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

def orElse[A1 <: K, B1 >: V](that: PartialFunction[A1, B1]): PartialFunction[A1, B1]

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

A1

тип аргумента резервной функции

B1

тип результата резервной функции

that

резервная функция

returns

частичная функция, которая имеет в качестве области определения объединение областей определения этой частичной функции и that. Результирующая частичная функция переводит x в this(x), где this определено, и в that(x), где оно не определено.

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

def partition(p: ((K, V)) => Boolean): (Map[K, V], Map[K, V])

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

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

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

def partitionMap[A1, A2](f: ((K, V)) => Either[A1, A2]): (Iterable[A1], Iterable[A2])

Применяет функцию f к каждому элементу итерируемой коллекции и возвращает пару итерируемых коллекций: первая состоит из тех значений, возвращаемых f, которые были обернуты в scala.util.Left, а вторая — из тех, которые были обернуты в scala.util.Right.

Пример:

val xs = Iterable(1, "one", 2, "two", 3, "three") partitionMap {
 case i: Int => Left(i)
 case s: String => Right(s)
}
// xs == (Iterable(1, 2, 3),
//        Iterable(one, two, three))
A1

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

A2

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

f

'функция разделения', отображающая элементы этой итерируемой коллекции на scala.util.Either

returns

пара итерируемых коллекций: первая состоит из тех значений, возвращаемых f, которые были обернуты в scala.util.Left, а вторая — из тех, которые были обернуты в scala.util.Right.

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

def product[B >: (K, V)](implicit num: math.Numeric[B]): B

Перемножает элементы этой коллекции.

B

тип результата оператора *.

num

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

returns

произведение всех элементов этой коллекции относительно оператора * в num.

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

def reduce[B >: (K, V)](op: (B, B) => B): B

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

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

B

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

op

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

returns

Результат применения оператора свёртки op ко всем элементам, если коллекция не пуста.

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

def reduceLeft[B >: (K, V)](op: (B, (K, V)) => B): B

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

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

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

B

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

op

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

returns

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

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

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

def reduceLeftOption[B >: (K, V)](op: (B, (K, V)) => B): Option[B]

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

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

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

B

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

op

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

returns

опциональное значение, содержащее результат reduceLeft(op) если эта коллекция не пуста, None в противном случае.

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

def reduceOption[B >: (K, V)](op: (B, B) => B): Option[B]

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

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

B

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

op

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

returns

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

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

def reduceRight[B >: (K, V)](op: ((K, V), B) => B): B

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

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

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

B

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

op

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

returns

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

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

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

Определяющие классы
IterableOnceOps
Выбрасываемые исключения

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

def reduceRightOption[B >: (K, V)](op: ((K, V), B) => B): Option[B]

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

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

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

B

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

op

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

returns

опциональное значение, содержащее результат reduceRight(op) если эта коллекция не пуста, None в противном случае.

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

def removedAll(keys: IterableOnce[K]): Map[K, V]

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

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

keys

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

returns

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

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

def reversed: collection.Iterable[(K, V)]

Атрибуты
protected
Определяющие классы
IterableOnceOps

def runWith[U](action: (V) => U): (K) => Boolean

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

Обратите внимание, что выражение pf.runWith(action)(x) эквивалентно

if(pf isDefinedAt x) { action(pf(x)); true } else false

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

action

функция действия

returns

функция, которая отображает аргументы x на isDefinedAt(x). Результирующая функция запускает action(this(x)), где определено this.

Определяющие классы
PartialFunction
С версии

2.10

См. также

applyOrElse.

def scan[B >: (K, V)](z: B)(op: (B, B) => B): Iterable[B]

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

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

B

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

z

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

op

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

returns

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

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

def scanLeft[B](z: B)(op: (B, (K, V)) => B): Iterable[B]

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

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

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

B

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

z

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

op

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

returns

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

def scanRight[B](z: B)(op: ((K, V), B) => B): Iterable[B]

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

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

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

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

Пример:

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

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

z

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

op

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

returns

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

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

def size: Int

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

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

returns

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

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

def sizeCompare(that: collection.Iterable[_]): Int

Сравнивает размер этой итерируемой коллекции с размером другой Iterable.

that

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

returns

Значение x, где

x <  0       if this.size <  that.size
x == 0       if this.size == that.size
x >  0       if this.size >  that.size

Реализация метода здесь не вызывает size напрямую; его время выполнения составляет O(this.size min that.size) вместо O(this.size + that.size). Метод должен быть переопределён, если вычисление size является дешёвым, а knownSize возвращает -1.

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

def sizeCompare(otherSize: Int): Int

Сравнивает размер этого итерируемого набора с тестовым значением.

otherSize

тестовое значение, которое сравнивается с размером.

returns

Значение x, где

x <  0       if this.size <  otherSize
x == 0       if this.size == otherSize
x >  0       if this.size >  otherSize

Реализация метода здесь не вызывает size напрямую; его время выполнения составляет O(size min otherSize) вместо O(size). Метод следует переопределить, если вычисление size является быстрым и knownSize возвращает -1.

Definition Classes
IterableOps
See also

sizeIs

final def sizeIs: SizeCompareOps

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

Эти операции реализованы с точки зрения sizeCompare(Int) и позволяют использовать следующие более читабельные выражения:

this.sizeIs < size     // this.sizeCompare(size) < 0
this.sizeIs <= size    // this.sizeCompare(size) <= 0
this.sizeIs == size    // this.sizeCompare(size) == 0
this.sizeIs != size    // this.sizeCompare(size) != 0
this.sizeIs >= size    // this.sizeCompare(size) >= 0
this.sizeIs > size     // this.sizeCompare(size) > 0
Definition Classes
IterableOps
Annotations
@inline()

def slice(from: Int, until: Int): Map[K, V]

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

from <= indexOf(x) < until

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

from

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

until

наименьший индекс для исключения из этого итерируемого набора.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def sliding(size: Int, step: Int): Iterator[Map[K, V]]

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

size

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

step

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

returns

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

Definition Classes
IterableOps
See also

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

def sliding(size: Int): Iterator[Map[K, V]]

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

size

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

returns

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

Definition Classes
IterableOps
See also

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

def span(p: ((K, V)) => Boolean): (Map[K, V], Map[K, V])

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

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

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

p

тестовый предикат

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

def splitAt(n: Int): (Map[K, V], Map[K, V])

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

Примечание: c splitAt n эквивалентно (но возможно более эффективно, чем) (c take n, c drop n).

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

n

позиция, в которой необходимо разделить.

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

Возвращает Stepper для элементов этой коллекции.

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

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

    Для коллекций Int, Short, Byte или Char, возвращается IntStepperДля коллекций Double или Float, возвращается DoubleStepperДля коллекций Long, возвращается LongStepperДля любого другого типа элементов возвращается AnyStepper

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

Definition Classes
IterableOnce

def stringPrefix: String

Attributes
protected[this]
Definition Classes
Map → Iterable
Annotations
@deprecatedOverriding("Compatibility override", "2.13.0")

def sum[B >: (K, V)](implicit num: math.Numeric[B]): B

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

B

тип результата оператора +.

num

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

returns

сумма всех элементов этой коллекции относительно оператора + в num.

Definition Classes
IterableOnceOps

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def tail: Map[K, V]

Остальная часть коллекции без первого элемента.

Definition Classes
IterableOps

def tails: Iterator[Map[K, V]]

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

returns

итератор по всем хвостам этой итерируемой коллекции

Definition Classes
IterableOps
Пример:

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

def take(n: Int): Map[K, V]

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

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

n

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

возвращает

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

Определяющие классы
IterableOps → IterableOnceOps
Примечание

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

def takeRight(n: Int): Map[K, V]

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

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

n

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

возвращает

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

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

def takeWhile(p: ((K, V)) => Boolean): Map[K, V]

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

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

p

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

возвращает

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

Определяющие классы
IterableOps → IterableOnceOps

def tapEach[U](f: ((K, V)) => U): Map[K, V]

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

U

тип возвращаемого значения f

f

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

возвращает

такая же логическая коллекция, как и эта

Определяющие классы
IterableOps → IterableOnceOps

def to[C1](factory: Factory[(K, V), C1]): C1

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

xs.to(List) xs.to(ArrayBuffer) xs.to(BitSet) // для xs: Iterable[Int]

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

def toArray[B >: (K, V)](implicit arg0: ClassTag[B]): Array[B]

Преобразовать коллекцию в массив.

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

final def toBuffer[B >: (K, V)]: Buffer[B]

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

def toIndexedSeq: IndexedSeq[(K, V)]

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

final def toIterable: AbstractMap.this.type

возвращает

Эту коллекцию как Iterable[A]. Новая коллекция не будет построена, если this уже является Iterable[A].

Определяющие классы
Iterable → IterableOps

def toList: List[(K, V)]

Definition Classes
IterableOnceOps

final def toMap[K2, V2](implicit ev: <:<[(K, V), (K2, V2)]): Map[K2, V2]

Definition Classes
Map → IterableOnceOps

def toSeq: Seq[(K, V)]

возвращает

Этот набор как Seq[A]. Это эквивалентно to(Seq), но может быть быстрее.

Definition Classes
IterableOnceOps

def toSet[B >: (K, V)]: Set[B]

Definition Classes
IterableOnceOps

def toString(): String

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

возвращает

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

Definition Classes
Map → Function1 → Iterable → AnyRef → Any

def toVector: Vector[(K, V)]

Definition Classes
IterableOnceOps

def transform[W](f: (K, V) => W): Map[K, W]

Эта функция преобразует все значения отображений, содержащихся в этом отображении, с помощью функции f.

f

Функция над ключами и значениями

возвращает

обновлённое отображение

Definition Classes
MapOps

def transpose[B](implicit asIterable: ((K, V)) => collection.Iterable[B]): Iterable[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

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

asIterable

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

возвращает

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

Definition Classes
IterableOps
Исключения

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

def unapply(a: K): Option[V]

Пытается извлечь B из A в выражении сопоставления с образцом.

Definition Classes
PartialFunction

def unlift: PartialFunction[K, B]

Преобразует необязательную функцию в частичную функцию.

Неявный
Этот член добавлен неявным преобразованием из AbstractMap[K, V] вUnliftOps[K, B] выполненное методом UnliftOps в scala.Function1.Это преобразование произойдёт только если V является подклассом Option[B] (V <: Option[B]).
Классы определения
UnliftOps
Пример:

    В отличие от Function.unlift, этот метод UnliftOps.unlift можно использовать в экстракторах.

    val of: Int => Option[String] = { i =>
      if (i == 2) {
        Some("matched by an optional function")
      } else {
        None
      }
    }
    
    util.Random.nextInt(4) match {
      case of.unlift(m) => // Convert an optional function to a pattern
        println(m)
      case _ =>
        println("Not matched")
    }

def unzip[A1, A2](implicit asPair: ((K, V)) => (A1, A2)): (Iterable[A1], 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

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

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

def unzip3[A1, A2, A3](implicit asTriple: ((K, V)) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], 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

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

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

def updatedWith[V1 >: V](key: K)(remappingFunction: (Option[V]) => Option[V1]): Map[K, V1]

Обновляет отображение для указанного ключа и его текущего, необязательно отображённого значения (Some если есть текущее отображение, None если нет).

Если функция переназначения возвращает Some(v), отображение обновляется с новым значением v. Если функция переназначения возвращает None, отображение удаляется (или остаётся отсутствующим, если оно изначально отсутствовало). Если сама функция генерирует исключение, исключение перебрасывается, а текущее отображение остается неизменным.

key

значение ключа

remappingFunction

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

returns

новый массив с обновлённым отображением с ключом

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

2.13.0

def valueStepper[S <: Stepper[_]](implicit shape: StepperShape[V, S]): S

Возвращает Stepper для значений этого массива. См. метод stepper.

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

def values: collection.Iterable[V]

Собирает все значения этого массива в итерируемую коллекцию.

returns

значения этого массива как итерируемая коллекция.

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

def valuesIterator: Iterator[V]

Создаёт итератор для всех значений в этом массиве.

returns

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

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

def view: MapView[K, V]

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

Definition Classes
MapOps → IterableOps

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

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

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

def withDefault[V1 >: V](d: (K) => V1): Map[K, V1]

То же самое отображение с заданной функцией по умолчанию. Примечание: значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys, и т. д., не зависят от withDefault.

Вызов методов преобразования (например, map) не сохранит значение по умолчанию.

d

функция сопоставления ключей со значениями, используемая для отсутствующих ключей

returns

обёртка отображения со значением по умолчанию

Definition Classes
Map

def withDefaultValue[V1 >: V](d: V1): Map[K, V1]

То же самое отображение с заданным значением по умолчанию. Примечание: значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys, и т. д., не зависят от withDefaultValue.

Вызов методов преобразования (например, map) не сохранит значение по умолчанию.

d

значение по умолчанию, используемое для отсутствующих ключей

returns

обёртка отображения со значением по умолчанию

Definition Classes
Map

def withFilter(p: ((K, V)) => Boolean): MapOps.WithFilter[K, V, [x]Iterable[x], [x, y]Map[x, y]]

Создаёт нестрогий фильтр этого отображения.

Примечание: разница между c filter p и c withFilter p заключается в том, что первый создаёт новый набор, а второй только ограничивает область действия последующих map, flatMap, foreach, и withFilter операций.

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

p

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

returns

объект класса WithFilter, который поддерживает map, flatMap, foreach, и withFilter операции. Все эти операции применяются к тем элементам этого отображения, которые удовлетворяют предикату p.

Definition Classes
MapFactoryDefaults → IterableOps

def zip[B](that: IterableOnce[B]): Iterable[((K, V), B)]

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

B

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

that

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

returns

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

Definition Classes
IterableOps

def zipAll[A1 >: (K, V), B](that: collection.Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

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

that

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

thisElem

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

thatElem

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

returns

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

Definition Classes
IterableOps

def zipWithIndex: Iterable[((K, V), Int)]

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Пример:

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

Note

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

Затенённые неявные члены-значения

def +(other: String): String

Неявный
Этот член добавлен неявным преобразованием из AbstractMap[K, V] в any2stringadd[AbstractMap[K, V]] при помощи метода any2stringadd в scala.Predef.
Затенение
Этот неявный унаследованный член затенено одним или несколькими членами в этом классе.
Для доступа к этому члену можно использовать описание типа:
(abstractMap: any2stringadd[AbstractMap[K, V]]).+(other)
Definition Classes
any2stringadd

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/collection/immutable/AbstractMap.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API