Spec-Zone.ru › Scala 2.12 Library

Trait scala.collection.mutable.ReusableBuilder

trait ReusableBuilder[-Elem, +To] extends Builder[Elem, To]

ReusableBuilder - это маркерный трайт, который указывает, что Builder можно повторно использовать для построения более чем одного экземпляра коллекции. В частности, вызов result за которым следует clear создаст коллекцию и сбросит билдер, чтобы начать построение новой коллекции того же типа.

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

Elem

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

To

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

Source
ReusableBuilder.scala
Since

2.12

Linear Supertypes
Known Subclasses

Abstract Value Members

abstract def +=(elem: Elem): ReusableBuilder.this.type

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

elem

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

returns

сам билдер.

Definition Classes
Builder → Growable

abstract def clear(): Unit

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

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

Definition Classes
ReusableBuilder → Builder → Growable → Clearable

abstract def result(): To

Создаёт коллекцию из добавленных элементов.

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

returns

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

Definition Classes
ReusableBuilder → Builder

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

final def !=(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

returns

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

Definition Classes
AnyRef → Any

def +(other: String): String

Неявный
Этот член добавляется с помощью неявного преобразования из ReusableBuilder[Elem, To] в any2stringadd[ReusableBuilder[Elem, To]] путём метода any2stringadd в scala.Predef.
Definition Classes
any2stringadd

def ++=(xs: TraversableOnce[Elem]): ReusableBuilder.this.type

Добавляет все элементы, полученные от TraversableOnce, в этот изменяемый набор.

xs

TraversableOnce, производящий элементы для добавления.

returns

сам изменяемый набор.

Definition Classes
Growable

def +=(elem1: Elem, elem2: Elem, elems: Elem*): ReusableBuilder.this.type

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

elem1

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

elem2

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

elems

Остальные элементы для добавления.

returns

сам изменяемый набор

Definition Classes
Growable

def ->[B](y: B): (ReusableBuilder[Elem, To], B)

Неявный
Этот член добавляется с помощью неявного преобразования из ReusableBuilder[Elem, To] в ArrowAssoc[ReusableBuilder[Elem, To]] путём метода ArrowAssoc в scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

final def ==(arg0: Any): Boolean

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

returns

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

Definition Classes
AnyRef → Any

final def asInstanceOf[T0]: T0

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

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

returns

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

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

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

def clone(): AnyRef

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

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

returns

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

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
Примечание

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

def ensuring(cond: (ReusableBuilder[Elem, To]) ⇒ Boolean, msg: ⇒ Any): ReusableBuilder[Elem, To]

Неявный
Этот член добавлен с помощью неявного преобразования из ReusableBuilder[Elem, To] в Ensuring[ReusableBuilder[Elem, To]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: (ReusableBuilder[Elem, To]) ⇒ Boolean): ReusableBuilder[Elem, To]

Неявный
Этот член добавлен с помощью неявного преобразования из ReusableBuilder[Elem, To] в Ensuring[ReusableBuilder[Elem, To]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: Boolean, msg: ⇒ Any): ReusableBuilder[Elem, To]

Неявный
Этот член добавлен с помощью неявного преобразования из ReusableBuilder[Elem, To] в Ensuring[ReusableBuilder[Elem, To]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
Ensuring

def ensuring(cond: Boolean): ReusableBuilder[Elem, To]

Неявный
Этот член добавлен с помощью неявного преобразования из ReusableBuilder[Elem, To] в Ensuring[ReusableBuilder[Elem, To]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
Ensuring

final def eq(arg0: AnyRef): Boolean

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

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

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

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

возвращает

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

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

def equals(arg0: Any): Boolean

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

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

возвращает

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

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

def finalize(): Unit

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

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

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

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

def formatted(fmtstr: String): String

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

Неявный
Этот член добавляется с помощью неявного преобразования из ReusableBuilder[Elem, To] в StringFormat[ReusableBuilder[Elem, To]] с помощью метода StringFormat в scala.Predef.
Определяющие классы
StringFormat
Аннотации
@inline()

final def getClass(): Class[_]

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

возвращает

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

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

def hashCode(): Int

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

возвращает

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

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

final def isInstanceOf[T0]: Boolean

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

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

возвращает

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

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

def mapResult[NewTo](f: (To) ⇒ NewTo): Builder[Elem, NewTo]

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

NewTo

тип коллекции, возвращаемой результатом f.

f

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

возвращает

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

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

Исходный билдер больше не должен использоваться после вызова mapResult.

final def ne(arg0: AnyRef): Boolean

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

возвращает

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

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

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

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

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

def sizeHint(coll: TraversableLike[_, _], delta: Int): Unit

Предполагает, что размер этого билдера будет равен размеру заданной коллекции плюс некоторое значение delta. Это предположение используется только если у коллекции есть метод size, который выполняется быстро. В настоящий момент это предположение справедливо только для коллекций типа IndexedSeqLike. Некоторые классы билдеров оптимизируют свою внутреннюю структуру, основываясь на этом предположении. Однако реализации билдеров должны корректно работать даже если предположение ошибочно, т.е. если добавлено другое количество элементов.

coll

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

delta

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

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

def sizeHint(coll: TraversableLike[_, _]): Unit

Даёт подсказку о том, что ожидается, что result этого билдера будет иметь тот же размер, что и заданная коллекция, плюс некоторая дельта. Это будет давать подсказку только в том случае, если известно, что коллекция имеет дешёвый метод size, который определяется вызовом sizeHint.

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

coll

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

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

def sizeHint(size: Int): Unit

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

size

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

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

def sizeHintBounded(size: Int, boundingColl: TraversableLike[_, _]): Unit

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

size

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

boundingColl

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

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

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

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

def toString(): String

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

возвращает

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

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

final def wait(): Unit

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

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

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

final def wait(arg0: Long): Unit

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

def →[B](y: B): (ReusableBuilder[Elem, To], B)

Неявный
Этот член добавлен неявным преобразованием из ReusableBuilder[Elem, To] в ArrowAssoc[ReusableBuilder[Elem, To]] выполненным методом ArrowAssoc в scala.Predef.
Классы определения
ArrowAssoc

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/collection/mutable/ReusableBuilder.html

Spec-Zone.ru

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