Spec-Zone.ru › Scala 2.13 Library

Класс scala.collection.mutable.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]], Shrinkable[K], Builder[(K, V), Map[K, V]], Growable[(K, V)], Clearable, Cloneable[Map[K, V]], java.lang.Cloneable, 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, collection.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
Известные подклассы
TrieMap, AnyRefMap, CollisionProofHashMap, HashMap, LinkedHashMap, LongMap, WithDefault, WithDefault, TreeMap, SystemProperties, ListMap, OpenHashMap

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

new AbstractMap()

Члены типов

trait GenKeySet extends AnyRef

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

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

class KeySet extends AbstractSet[K] with GenKeySet with DefaultSerializable

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

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

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

abstract def addOne(elem: (K, V)): AbstractMap.this.type

Добавляет один элемент в это изменяемое множество.

elem

элемент для добавления.

returns

само изменяемое множество

Definition Classes
Growable

abstract def get(key: K): Option[V]

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

key

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

returns

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

Definition Classes
MapOps

abstract def iterator: Iterator[(K, V)]

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

Definition Classes
IterableOnce

abstract def subtractOne(elem: K): AbstractMap.this.type

Удаляет один элемент из этого уменьшаемого набора.

elem

элемент для удаления.

returns

само уменьшаемое множество

Definition Classes
Shrinkable

Члены конкретных значений

final def !=(arg0: Any): Boolean

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

возвращает

true, если !(this == that), иначе false.

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

final def ##(): Int

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

возвращает

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

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

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

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

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

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

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

Классы определений
IterableOps
Аннотации
@inline()

final def ++=(xs: IterableOnce[(K, V)]): AbstractMap.this.type

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

Классы определений
Growable
Аннотации
@inline()

final def +=(elem: (K, V)): AbstractMap.this.type

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

Definition Classes
Growable
Annotations
@inline()

final def --=(xs: IterableOnce[K]): AbstractMap.this.type

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

Definition Classes
Shrinkable
Annotations
@inline()

def -=(elem1: K, elem2: K, elems: K*): AbstractMap.this.type

Удаляет два или более элементов из этого уменьшаемого набора.

elem1

первый элемент для удаления.

elem2

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

elems

остальные элементы для удаления.

returns

сам уменьшаемый набор

Definition Classes
Shrinkable

final def -=(elem: K): AbstractMap.this.type

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

Definition Classes
Shrinkable
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]).
Классы определения
ArrowAssoc
Аннотации
@inline()

final def ==(arg0: Any): Boolean

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

возвращает

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

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

def addAll(xs: IterableOnce[(K, V)]): AbstractMap.this.type

Добавляет все элементы, созданные IterableOnce, в это изменяемое множество.

xs

IterableOnce, создающий элементы для добавления.

возвращает

само изменяемое множество.

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

def addString(sb: 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)
start

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

sep

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

end

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

returns

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

Definition Classes
MapOps → IterableOnceOps

final 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

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

returns

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

Definition Classes
IterableOnceOps
Annotations
@inline()

final 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, в который были добавлены элементы.

Definition Classes
IterableOnceOps
Annotations
@inline()

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

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction

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

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

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

C

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

k

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

returns

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

Definition Classes
PartialFunction → Function1

def apply(key: K): V

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

key

ключ

returns

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

Definition Classes
MapOps → Function1
Annotations
@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

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

returns

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

Definition Classes
MapOps → PartialFunction
Since

2.10

final def asInstanceOf[T0]: T0

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

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

returns

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

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

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

def canEqual(that: Any): Boolean

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

that

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

returns

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

Definition Classes
Map → Equals

def className: String

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

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

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

returns

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

Атрибуты
protected[this]
Определяющие классы
Iterable

def clear(): Unit

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

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

def clone(): Map[K, V]

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

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

returns

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

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

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

final def coll: AbstractMap.this.type

returns

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

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

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

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

K2

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

V2

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

pf

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

returns

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

Definition Classes
MapOps

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

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

B

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

pf

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

pf

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

returns

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

Definition Classes
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)).

Definition Classes
PartialFunction

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

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

A

тип, к которому можно применить функцию g

g

функция A => T1

returns

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

Definition Classes
Function1
Annotations
@unspecialized()

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

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

suffix

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

returns

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

Definition Classes
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) истинно для всех соответствующих элементов 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]

Неявное
Этот член добавлен с помощью неявного преобразования из AbstractMap[K, V] в Ensuring[AbstractMap[K, V]], выполненного методом Ensuring в scala.Predef.
Определяющие классы
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 реализует отношение эквивалентности эквивалентности на не-null экземплярах AnyRef и обладает тремя дополнительными свойствами:

    Он согласован: для любых не-null экземпляров x и y типа AnyRef, многократные вызовы x.eq(y) последовательно возвращают значение true или последовательно возвращают значение false.Для любого не-null экземпляра 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]

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def filterInPlace(p: (K, V) => Boolean): AbstractMap.this.type

Оставляет только те сопоставления, для которых предикат p возвращает true.

p

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

Definition Classes
MapOps

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

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

pred

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

def finalize(): Unit

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
Note

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

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

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

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

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

p

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

returns

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

Definition Classes
IterableOnceOps

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

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

f

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

returns

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

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

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

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

A1

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

z

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

op

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

returns

результат применения оператора fold 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.

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

Attributes
protected
Definition Classes
MapFactoryDefaults → IterableOps
Note

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

,

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

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

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

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

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

V1

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

key

ключ.

default

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

returns

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

Definition Classes
MapOps

def getOrElseUpdate(key: K, op: => V): V

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

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

Реализации конкурирующих карт могут вычислять выражение op несколько раз или могут вычислять op без вставки результата.

key

ключ для проверки

op

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

returns

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

Definition Classes
MapOps

def groupBy[K](f: ((K, V)) => K): immutable.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): immutable.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): immutable.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

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

returns

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

Definition Classes
IterableOps
See also

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

def hashCode(): Int

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

returns

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

Definition Classes
Map → AnyRef → Any

def head: (K, V)

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

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

returns

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

Definition Classes
IterableOps
Exceptions thrown

NoSuchElementException, если итерабельная коллекция пуста.

def headOption: Option[(K, V)]

Возвращает первый элемент, если он существует.

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

returns

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

Definition Classes
IterableOps

def init: Map[K, V]

Часть коллекции без последнего элемента.

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

Definition Classes
IterableOps

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

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

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

returns

итератор по всем начальным элементам (inits) этого итерируемого набора

Definition Classes
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

ключ

returns

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

Definition Classes
MapOps → PartialFunction

def isEmpty: Boolean

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

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

returns

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

Definition Classes
IterableOnceOps

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

def isTraversableAgain: Boolean

Проверяет, может ли эта итерируемая коллекция быть повторно пройдена. Всегда true для Iterables и false для Iterators, если не переопределено.

returns

true, если она может быть повторно пройдена, false в противном случае.

Definition Classes
IterableOps → IterableOnceOps

def iterableFactory: IterableFactory[Iterable]

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

Definition Classes
Iterable → Iterable → IterableOps
Note

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

def keySet: collection.Set[K]

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

returns

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

Definition Classes
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 в противном случае. По умолчанию реализация всегда возвращает -1.

Definition Classes
MapOps → Growable → 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.

returns

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

Definition Classes
PartialFunction
См. также

Function.unlift

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

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

f

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

returns

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

Definition Classes
MapOps

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

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

B

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

f

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Примечание

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

def mapFactory: MapFactory[Map]

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

Definition Classes
Map → Map → MapOps
Примечание

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

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

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

Attributes
protected
Definition Classes
MapOps
Annotations
@inline()

def mapResult[NewTo](f: (Map[K, V]) => NewTo): Builder[(K, V), NewTo]

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

Definition Classes
Builder

def mapValuesInPlace(f: (K, V) => V): AbstractMap.this.type

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

f

преобразование, которое нужно применить

returns

сама карта.

Definition Classes
MapOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

B

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

f

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

cmp

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

returns

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

Definition Classes
IterableOnceOps

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

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

B

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

ord

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

returns

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

Definition Classes
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 вместо этого метода.

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

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

,

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

def nonEmpty: Boolean

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

returns

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

Классы-определения
IterableOnceOps
Аннотации
@deprecatedOverriding("nonEmpty is defined as !isEmpty; override isEmpty instead", "2.13.0")

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

Классы-определения
AnyRef
Аннотации
@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), где она не определена.

Definition Classes
PartialFunction

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

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

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

Definition Classes
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.

Definition Classes
IterableOps

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

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

B

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

num

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

returns

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

Definition Classes
IterableOnceOps

def put(key: K, value: V): Option[V]

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

key

ключ для обновления

value

новое значение

returns

опциональное значение, содержащее значение, связанное с ключом до выполнения операции put, или None, если key не было определено в карте ранее.

Definition Classes
MapOps

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

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

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

B

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

op

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

returns

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

Definition Classes
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 — элементы этого набора.

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

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

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

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

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

B

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

op

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

returns

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

Definition Classes
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 — элементы этой коллекции.

Definition Classes
IterableOnceOps
Exceptions thrown

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

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

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

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

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

B

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

op

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

returns

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

Definition Classes
IterableOnceOps

def remove(key: K): Option[V]

Удаляет ключ из этой карты, возвращая значение, связанное ранее с этим ключом, как значение типа Option.

key

ключ, который нужно удалить

returns

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

Definition Classes
MapOps

def result(): Map[K, V]

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

Definition Classes
MapOps → Builder

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

Attributes
protected
Definition Classes
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 определено.

Definition Classes
PartialFunction
Since

2.10

See also

applyOrElse.

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps

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

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

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

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

B

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

z

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

op

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

returns

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

Definition Classes
IterableOps → IterableOnceOps
Note

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

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

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

Definition Classes
IterableOps

def size: Int

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

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

returns

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

Definition Classes
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.

Definition Classes
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 sizeHint(coll: IterableOnce[_], delta: Int = 0): Unit

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

coll

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

delta

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

Definition Classes
Builder

def sizeHint(size: Int): Unit

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

size

подсказка о том, сколько элементов будет добавлено.

Definition Classes
Builder

final def sizeHintBounded(size: Int, boundingColl: collection.Iterable[_]): Unit

Даёт подсказку о том, сколько элементов ожидается добавить при вызове следующего result, а также верхнюю границу, заданную размером другого набора. Некоторые классы билдеров оптимизируют своё представление на основе подсказки. Однако реализации билдеров по-прежнему должны работать корректно, даже если подсказка неверна, то есть добавлено другое количество элементов.

size

подсказка о том, сколько элементов будет добавлено.

boundingColl

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

Definition Classes
Builder

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 subtractAll(xs: IterableOnce[K]): AbstractMap.this.type

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

xs

итератор, генерирующий элементы для удаления.

returns

сама изменяемая коллекция

Definition Classes
Shrinkable

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

Суммирует элементы этого набора.

B

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

num

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

возвращает

сумму всех элементов этого набора по отношению к оператору + в num.

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

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

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

def tail: Map[K, V]

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

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

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

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

возвращает

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

Определяющие классы
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

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

returns

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

Definition Classes
IterableOps

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

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

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

p

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

returns

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

Definition Classes
IterableOps → IterableOnceOps

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

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

U

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

f

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

returns

тот же логический набор, что и этот

Definition Classes
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]

Definition Classes
IterableOnceOps

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

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps
Annotations
@inline()

def toIndexedSeq: immutable.IndexedSeq[(K, V)]

Definition Classes
IterableOnceOps

final def toIterable: AbstractMap.this.type

возвращает

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

Definition Classes
Iterable → IterableOps

def toList: immutable.List[(K, V)]

Definition Classes
IterableOnceOps

def toMap[K, V](implicit ev: <:<[(K, V), (K, V)]): immutable.Map[K, V]

Definition Classes
IterableOnceOps

def toSeq: immutable.Seq[(K, V)]

returns

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

Definition Classes
IterableOnceOps

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

Definition Classes
IterableOnceOps

def toString(): String

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

returns

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

Definition Classes
Map → Function1 → Iterable → AnyRef → Any

def toVector: immutable.Vector[(K, V)]

Definition Classes
IterableOnceOps

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.

returns

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

Definition Classes
IterableOps
Exceptions thrown

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

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

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

Definition Classes
PartialFunction

def unlift: PartialFunction[K, B]

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

Implicit
Этот член добавляется неявным преобразованием от AbstractMap[K, V] к UnliftOps[K, B], выполненному методом UnliftOps в scala.Function1. Это преобразование будет выполнено только в том случае, если V является подклассом Option[B] (V <: Option[B]).
Definition Classes
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

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

Definition Classes
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

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

Definition Classes
IterableOps

def update(key: K, value: V): Unit

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

key

Ключ для обновления

value

Новое значение

Definition Classes
MapOps

def updateWith(key: K)(remappingFunction: (Option[V]) => Option[V]): Option[V]

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

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

key

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

remappingFunction

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

returns

новое значение, связанное с указанным ключом

Definition Classes
MapOps
Since

2.13.0

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

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

Definition Classes
MapOps

def values: collection.Iterable[V]

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

returns

значения этого отображения в виде итерируемого набора.

Definition Classes
MapOps

def valuesIterator: Iterator[V]

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

returns

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

Definition Classes
MapOps

def view: MapView[K, V]

Просмотр элементов этого набора.

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

final def wait(): Unit

Классы определений
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

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

Классы определений
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Классы определений
AnyRef
Аннотации
@throws(classOf[java.lang.InterruptedException]) @native()

def withDefault(d: (K) => V): Map[K, V]

Такая же карта с заданной функцией по умолчанию. Примечание: значение по умолчанию используется только для apply. Другие методы, такие как get, contains, iterator, keys и т. д., не затрагиваются withDefaultValue.

Вызов методов преобразования (например, map) не сохранит значение по умолчанию.

d

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

returns

обёртка карты со значением по умолчанию

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

def withDefaultValue(d: V): Map[K, V]

Та же карта с заданным значением по умолчанию. Примечание: значение по умолчанию используется только для 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)
Определяющие классы
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/mutable/AbstractMap.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API