Spec-Zone.ru › Scala 3.2

Класс Regex.MatchIterator

Исходный код

class MatchIterator(val source: CharSequence, val regex: Regex, val _groupNames: Seq[String]) extends AbstractIterator[String] with Iterator[String] with MatchData

Класс для перебора последовательности совпадений с регулярным выражением.

Это итератор, возвращающий совпавшие строки.

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

Когда совпадения исчерпаны, запросы о данных совпадений вызовут java.lang.IllegalStateException.

См. также

java.util.regex.Matcher

Надтипы
Трейт MatchData
Класс AbstractIterator[String]
Трейт Iterator[String]
Трейт IterableOnceOps[String, Iterator, Iterator[String]]
Трейт IterableOnce[String]
Класс Object
Трейт Matchable
Класс Any
Тип "Я сам"
MatchIterator

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

Исходный код
class GroupedIterator[B >: A](self: Iterator[B], size: Int, step: Int) extends AbstractIterator[Seq[B]]

Гибкий итератор для преобразования Iterator[A] в Iterator[Seq[A]] с настраиваемым размером последовательности, шагом и стратегией обработки элементов, которые не подходят равномерно.

Типичные применения можно достичь с помощью методов grouped и sliding.

Наследован от Iterator

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

Исходный код
def end: Int

Индекс последнего совпавшего символа.

Исходный код
def end(i: Int): Int

Индекс, следующий за последним совпавшим символом в группе i.

Исходный код
def groupCount: Int

Количество подгрупп.

Исходный код
def hasNext: Boolean

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

Исходный код
def matchData: Iterator[Match]

Преобразовать в итератор, который возвращает элементы MatchData вместо строк.

Исходный код
def next(): String

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

Исходный код
def start: Int

Индекс первого совпавшего символа.

Исходный код
def start(i: Int): Int

Индекс первого совпавшего символа в группе i.

Исходный код
override def toString: String

Сообщить о пустоте.

Определяющие классы MatchData -> Iterator -> Any

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

Исходный код
final def ++[B >: String](xs: => IterableOnce[B]): Iterator[B]

Наследован от Iterator

Исходный код
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

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

Возвращает

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

Наследован от IterableOnceOps

Исходный код
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

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

Возвращает

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

Наследован от IterableOnceOps

Исходный код
def addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder

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

Пример:

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

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

scala> a.addString(b , "List(" , ", " , ")")
res5: StringBuilder = List(1, 2, 3, 4)
Параметры значений
b

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

end

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

sep

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

start

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

Возвращает

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

Наследован от IterableOnceOps

Источник
def after(i: Int): CharSequence

Последовательность символов после последнего символа совпадения в группе i, или null если для этой группы ничего не совпало.

Унаследовано от MatchData

Источник
def after: CharSequence

Возвращает последовательность символов после последнего символа совпадения, или null если ничего не совпало.

Унаследовано от MatchData

Источник
def before(i: Int): CharSequence

Последовательность символов перед первым символом совпадения в группе i, или null если для этой группы ничего не совпало.

Унаследовано от MatchData

Источник
def before: CharSequence

Последовательность символов перед первым символом совпадения, или null если ничего не совпало.

Унаследовано от MatchData

Источник
def buffered: BufferedIterator[A]

Создаёт буферизованный итератор из данного итератора.

Возвращает

буферизованный итератор, производящий те же значения, что и этот итератор.

См. также

scala.collection.BufferedIterator

Примечание

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

Унаследовано от Iterator

Источник
def collect[B](pf: PartialFunction[String, B]): Iterator[B]

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

Параметры типа
B

тип элементов возвращённого итератора.

Параметры значения
pf

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

Возвращает

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

Унаследовано от Iterator

Источник
def collectFirst[B](pf: PartialFunction[String, B]): Option[B]

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

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

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

Параметры значения
pf

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

Возвращает

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

Пример

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

Унаследовано от IterableOnceOps

Источник
def concat[B >: String](xs: => IterableOnce[B]): Iterator[B]

Унаследовано от Iterator

Источник
def contains(elem: Any): Boolean

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

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

Параметры значения
elem

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

Возвращает

true если этот итератор производит какое-либо значение, которое равно (определяется по ==) elem, false в противном случае.

Примечание

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

Унаследовано от Iterator

Источник
def copyToArray[B >: String](xs: Array[B], start: Int, len: Int): Int

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

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

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

Параметры типа
B

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

Параметры значения
len

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

start

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

xs

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

Возвращает

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

Примечание

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

Унаследовано от IterableOnceOps

Источник
def copyToArray[B >: String](xs: Array[B], start: Int): Int

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

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

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

Параметры типа
B

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

Параметры значения
start

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

xs

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

Возвращает

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

Примечание

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

Унаследовано от IterableOnceOps

Источник
def copyToArray[B >: String](xs: Array[B]): Int

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

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

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

Параметры типа
B

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

Параметры значения
xs

массив, который нужно заполнить.

Возвращает

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

Примечание

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

Унаследовано от IterableOnceOps

Источник
def corresponds[B](that: IterableOnce[B])(p: (String, B) => Boolean): Boolean

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

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

Параметры типа
B

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

Параметры значения
p

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

that

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def count(p: String => Boolean): Int

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def distinct: Iterator[A]

Создает новый итератор из этого, без каких-либо дублированных элементов.

Возвращает

итератор с уникальными элементами

Примечание

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

Унаследовано от Iterator

Источник
def distinctBy[B](f: String => B): Iterator[A]

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

Параметры типа
B

тип элементов после преобразования с помощью f

Параметры значения
f

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

Возвращает

итератор с уникальными элементами

Примечание

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

Унаследовано от Iterator

Источник
def drop(n: Int): Iterator[A]

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

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

Параметры значения
n

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

Возвращает

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

Унаследовано от Iterator

Источник
def dropWhile(p: String => Boolean): Iterator[A]

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от Iterator

Источник
def duplicate: (Iterator[A], Iterator[A])

Создаёт две новые итерации, которые обе перебирают те же элементы, что и этот итератор (в том же порядке). Дублированные итераторы считаются равными, если они находятся на одном элементе.

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

Возвращает

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

Примечание

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

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

Унаследовано от Iterator

Источник
def exists(p: String => Boolean): Boolean

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def filter(p: String => Boolean): Iterator[A]

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

Параметры значения
p

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

Возвращает

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

Унаследовано от Iterator

Источник
def filterNot(p: String => Boolean): Iterator[A]

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

Параметры значения
pred

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

Возвращает

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

Унаследовано от Iterator

Source
def find(p: String => Boolean): Option[A]

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

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

Source
def flatMap[B](f: String => IterableOnce[B]): Iterator[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

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

Возвращает

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

Унаследовано от Iterator

Source
def flatten[B](implicit ev: String => IterableOnce[B]): Iterator[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.

Возвращает

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

Унаследовано от Iterator

Source
def fold[A1 >: String](z: A1)(op: (A1, A1) => A1): A1

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

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

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

Параметры типа
A1

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

Параметры значения
op

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

z

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

Возвращает

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

Унаследовано от IterableOnceOps

Source
def foldLeft[B](z: B)(op: (B, String) => B): B

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

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

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

Параметры типа
B

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

Параметры значения
op

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

z

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

Возвращает

результат вставки op между последовательными элементами этой коллекции слева направо с начальным значением z слева: op(...op(z, x1), x2, ..., xn) где x1, ..., xn - элементы этой коллекции. Возвращает z если эта коллекция пуста.

Унаследовано от IterableOnceOps

Source
def foldRight[B](z: B)(op: (String, B) => B): B

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

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

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

Параметры типа
B

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

Параметры значения
op

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

z

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

Возвращает

результат вставки op между последовательными элементами этой коллекции справа налево с начальным значением z справа: op(x1, op(x2, ... op(xn, z)...)) где x1, ..., xn - элементы этой коллекции. Возвращает z если эта коллекция пуста.

Унаследовано от IterableOnceOps

Source
def forall(p: String => Boolean): Boolean

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

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

Параметры значения
p

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

Возвращает

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

Унаследовано от IterableOnceOps

Source
def foreach[U](f: String => U): Unit

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

Унаследовано от IterableOnceOps

Source
def group(id: String): String

Возвращает группу с заданным именем.

Использует явные имена групп при их наличии; в противном случае запрашивает у базовой реализации имена встроенных групп. Не все платформы поддерживают встроенные имена групп.

Параметры значения
id

Имя группы

Возвращает

Запрошенная группа

Выбрасывает
IllegalArgumentException

если запрашиваемое имя группы не определено

Унаследовано от MatchData

Source
def group(i: Int): String

Совпавший строковый фрагмент в группе i, или null если ничего не совпало.

Наследуется от MatchData

Источник
def grouped[B >: String](size: Int): GroupedIterator[B]

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

// Returns List(List(1, 2, 3), List(4, 5, 6), List(7)))
(1 to 7).iterator.grouped(3).toList
// Returns List(List(1, 2, 3), List(4, 5, 6))
(1 to 7).iterator.grouped(3).withPartial(false).toList
// Returns List(List(1, 2, 3), List(4, 5, 6), List(7, 20, 25)
// Illustrating that withPadding's argument is by-name.
val it2 = Iterator.iterate(20)(_ + 5)
(1 to 7).iterator.grouped(3).withPadding(it2.next).toList
Примечание

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

Наследуется от Iterator

Источник
def indexOf[B >: String](elem: B, from: Int): Int

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

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

Параметры значения
elem

элемент, для поиска.

from

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

Возвращает

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

Примечание

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

Наследуется от Iterator

Источник
def indexOf[B >: String](elem: B): Int

Возвращает индекс первого вхождения указанного объекта в этом итерируемом объекте.

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

Параметры значения
elem

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

Возвращает

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

Примечание

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

Наследуется от Iterator

Источник
def indexWhere(p: String => Boolean, from: Int): Int

Наследуется от Iterator

Источник
override def isEmpty: Boolean

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

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

Возвращает

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

Определяющие классы Iterator -> IterableOnceOps
Наследуется от Iterator

Источник
def isTraversableAgain: Boolean

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

Возвращает

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

Наследуется от IterableOnceOps

Источник
final def iterator: Iterator[A]

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

Наследуется от Iterator

Источник
def knownSize: Int

Возвращает

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

Наследуется от IterableOnce

Источник
final def length: Int

Наследуется от Iterator

Источник
def map[B](f: String => B): Iterator[B]

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

Параметры типа
B

тип элемента возвращаемого итератора.

Параметры значения
f

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

Возвращает

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

Наследуется от Iterator

Источник
def matched: String

Совпавший строка или null если ничего не совпало.

Наследуется от MatchData

Источник
def max[B >: String](implicit ord: Ordering[B]): A

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Наследуется от IterableOnceOps

Источник
def maxBy[B](f: String => B)(implicit cmp: Ordering[B]): A

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Наследуется от IterableOnceOps
END_OF_DOCUMENT_MARKER

Source
def maxByOption[B](f: String => B)(implicit cmp: Ordering[B]): Option[A]

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Унаследованно от IterableOnceOps

Source
def maxOption[B >: String](implicit ord: Ordering[B]): Option[A]

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Унаследованно от IterableOnceOps

Source
def min[B >: String](implicit ord: Ordering[B]): A

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследованно от IterableOnceOps

Source
def minBy[B](f: String => B)(implicit cmp: Ordering[B]): A

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследованно от IterableOnceOps

Source
def minByOption[B](f: String => B)(implicit cmp: Ordering[B]): Option[A]

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

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

Параметры типа
B

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

Параметры значения
cmp

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

f

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

Возвращает

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

Унаследованно от IterableOnceOps

Source
def minOption[B >: String](implicit ord: Ordering[B]): Option[A]

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

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

Параметры типа
B

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

Параметры значения
ord

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
final def mkString: String

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

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
final def mkString(sep: String): String

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

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

Параметры значения
sep

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

Возвращает

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

Пример

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

Унаследовано от IterableOnceOps

Источник
final def mkString(start: String, sep: String, end: String): String

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

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

Параметры значения
end

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

sep

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

start

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

Возвращает

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

Пример

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

Унаследовано от IterableOnceOps

Источник
def nextOption(): Option[A]

Оборачивает значение next() в опцию.

Возвращает

Some(next) если следующий элемент существует, None в противном случае.

Унаследовано от Iterator

Источник
def nonEmpty: Boolean

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def padTo[B >: String](len: Int, elem: B): Iterator[B]

Копия этого итератора с добавленными элементами до достижения заданной длины.

Параметры типа
B

тип элементов возвращаемого итератора.

Параметры значения
elem

значение для заполнения

len

целевая длина

Возвращает

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

Унаследовано от Iterator

Источник
def partition(p: String => Boolean): (Iterator[A], Iterator[A])

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

Параметры значения
p

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

Возвращает

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

Примечание

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

Унаследовано от Iterator

Источник
def patch[B >: String](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]

Возвращает этот итератор с изменёнными значениями.

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

Параметры значения
from

Начальный индекс для замены

patchElems

Итератор значений для замены

replaced

Количество значений в исходном итераторе, которые заменяются заменой.

Примечание

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

Унаследовано от Iterator

Источник
def product[B >: String](implicit num: Numeric[B]): B

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

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

Параметры типа
B

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

Параметры значения
num

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def reduce[B >: String](op: (B, B) => B): B

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

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

Параметры типа
B

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

Параметры значения
op

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

Возвращает

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

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Source
def reduceLeft[B >: String](op: (B, String) => B): B

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

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

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

Параметры типа
B

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

Параметры значения
op

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

Возвращает

результат вставки op между последовательными элементами этой коллекции слева направо: op( op( ... op(x1, x2) ..., xn-1), xn) где x1, ..., xn - элементы этой коллекции.

Исключения
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Source
def reduceLeftOption[B >: String](op: (B, String) => B): Option[B]

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

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

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

Параметры типа
B

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

Параметры значения
op

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

Возвращает

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

Унаследовано от IterableOnceOps

Source
def reduceOption[B >: String](op: (B, B) => B): Option[B]

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

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

Параметры типа
B

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

Параметры значения
op

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

Возвращает

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

Унаследовано от IterableOnceOps

Source
def reduceRight[B >: String](op: (String, B) => B): B

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

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

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

Параметры типа
B

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

Параметры значения
op

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

Возвращает

результат вставки op между последовательными элементами этой коллекции, начиная справа налево: op(x1, op(x2, ..., op(xn-1, xn)...)) где x1, ..., xn — элементы этой коллекции.

Выбрасывает
UnsupportedOperationException

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

Унаследовано от IterableOnceOps

Источник
def reduceRightOption[B >: String](op: (String, B) => B): Option[B]

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

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

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

Параметры типа
B

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

Параметры значения
op

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
protected def reversed: Iterable[A]

Унаследовано от IterableOnceOps

Источник
def sameElements[B >: String](that: IterableOnce[B]): Boolean

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

Параметры типа
B

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

Параметры значения
that

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

Возвращает

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

Унаследовано от Iterator

Источник
def scanLeft[B](z: B)(op: (B, String) => B): Iterator[B]

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

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

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

Параметры типа
B

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

Параметры значения
op

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

z

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

Возвращает

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

Унаследовано от Iterator

Источник
def size: Int

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

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def slice(from: Int, until: Int): Iterator[A]

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

from <= indexOf(x) < until

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

Параметры значения
from

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

until

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

Возвращает

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

Унаследовано от Iterator

Источник
def sliding[B >: String](size: Int, step: Int): GroupedIterator[B]

Возвращает итератор, представляющий "скользящее окно" представления этого итератора. Первый аргумент — размер окна, а второй аргумент step — насколько продвигать окно на каждой итерации. step по умолчанию 1.

Возвращаемый GroupedIterator может быть настроен на заполнение частичного результата до размера size или подавление частичного результата полностью.

Примеры использования:

// Returns List(ArraySeq(1, 2, 3), ArraySeq(2, 3, 4), ArraySeq(3, 4, 5))
(1 to 5).iterator.sliding(3).toList
// Returns List(ArraySeq(1, 2, 3, 4), ArraySeq(4, 5))
(1 to 5).iterator.sliding(4, 3).toList
// Returns List(ArraySeq(1, 2, 3, 4))
(1 to 5).iterator.sliding(4, 3).withPartial(false).toList
// Returns List(ArraySeq(1, 2, 3, 4), ArraySeq(4, 5, 20, 25))
// Illustrating that withPadding's argument is by-name.
val it2 = Iterator.iterate(20)(_ + 5)
(1 to 5).iterator.sliding(4, 3).withPadding(it2.next).toList
Параметры значения
size

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

step

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

Возвращает

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

Примечание

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

Унаследовано от Iterator

Источник
def span(p: String => Boolean): (Iterator[A], Iterator[A])

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

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

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

Примечание

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

Унаследовано от Iterator

Источник
def splitAt(n: Int): (C, C)

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

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

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

Параметры значения
n

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

Возвращает

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

Унаследовано от IterableOnceOps

Источник
def stepper[S <: Stepper[_]](implicit shape: StepperShape[String, S]): S

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

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

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

  • Для коллекций Int, Short, Byte или Char, возвращается scala.collection.IntStepper

  • Для коллекций Double или Float, возвращается scala.collection.DoubleStepper

  • Для коллекций Long возвращается scala.collection.LongStepper

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

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

Наследуется от IterableOnce

Источник
def subgroups: Список[String]

Все группы захвата, т. е. не включая group(0).

Наследуется от MatchData

Источник
def sum[B >: String](implicit num: Numeric[B]): B

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

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

Параметры типа
B

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

Параметры значения
num

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

Возвращает

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

Наследуется от IterableOnceOps

Источник
def take(n: Int): Iterator[A]

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

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

Параметры значения
n

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

Возвращает

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

Наследуется от Iterator

Источник
def takeWhile(p: String => Boolean): Iterator[A]

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

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

Параметры значения
p

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

Возвращает

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

Наследуется от Iterator

Источник
override def tapEach[U](f: String => U): Iterator[A]

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

Параметры типа
U

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

Параметры значения
f

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

Возвращает

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

Классы определения Iterator -> IterableOnceOps
Наследуется от Iterator

Источник
def to[C1](factory: Factory[String, C1]): C1

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

xs.to(Список) xs.to(БуферМассивов) xs.to(МножествоБитов) // для xs: Iterable[Int]

Наследуется от IterableOnceOps

Источник
def toArray[B >: String : ClassTag]: Массив[B]

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

Примечание к реализации: НЕ вызывайте Array.from из этого метода.

Наследуется от IterableOnceOps

Источник
final def toBuffer[B >: String]: Буфер[B]

Наследуется от IterableOnceOps

Источник
def toIndexedSeq: ИндексированнаяПоследовательность[A]

Наследуется от IterableOnceOps

Источник
def toList: Список[A]

Наследуется от IterableOnceOps

Источник
def toMap[K, V](implicit ev: String <:< (K, V)): Карта[K, V]

Наследуется от IterableOnceOps

Источник
def toSeq: Последовательность[A]

Возвращает

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

Наследуется от IterableOnceOps

Source
def toSet[B >: String]: Set[B]

Inherited from IterableOnceOps

Source
def toVector: Vector[A]

Inherited from IterableOnceOps

Source
def withFilter(p: String => Boolean): Iterator[A]

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

Примечание: withFilter эквивалентно filter для итераторов. Оно необходимо для работы выражений for с фильтрами над итераторами.

Параметры
p

предикат для проверки значений.

Возвращаемое значение

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

Примечание

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

Унаследовано от Iterator

Source
def zip[B](that: IterableOnce[B]): Iterator[(A, B)]

Унаследовано от Iterator

Source
def zipAll[A1 >: String, B](that: IterableOnce[B], thisElem: A1, thatElem: B): Iterator[(A1, B)]

Унаследовано от Iterator

Source
def zipWithIndex: Iterator[(A, Int)]

Комбинирует этот итератор со своими индексами.

Возвращаемое значение

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

Пример

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

Унаследовано от Iterator

Конкретные поля

Source
val regex: Regex

Source
val source: CharSequence

Источник, из которого произошёл матч

© 2002-2022 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://scala-lang.org/api/3.2.0/scala/util/matching/Regex$$MatchIterator.html

Spec-Zone.ru

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