Spec-Zone.ru › Scala 2.13 Library

Трейт scala.concurrent.Promise

Компаньон объект Promise

Трейт Promise[T] extends AnyRef

Promise — это объект, который может быть завершён значением или ошибкой.

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

Источник
Promise.scala
Линейные супертипы
AnyRef, Any

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

абстрактный def future: Future[T]

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

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

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

возвращает

true если promise уже завершён, false в противном случае

абстрактный def tryComplete(result: Try[T]): Boolean

Попытка завершить promise значением или исключением.

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

возвращает

Если promise уже завершен, возвращает false, или true в противном случае.

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

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

Неявный
Этот член добавлен неявным преобразованием из Promise[T] вany2stringadd[Promise[T]], выполненное методом any2stringadd в scala.Predef.
Definition Classes
any2stringadd

def ->[B](y: B): (Promise[T], B)

Неявный
Этот член добавлен неявным преобразованием из Promise[T] вArrowAssoc[Promise[T]], выполненное методом 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[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Примечание

не специфицирован в SLS как член AnyRef

def complete(result: Try[T]): Promise.this.type

Завершает обещание исключением или значением.

result

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

def completeWith(other: Future[T]): Promise.this.type

Завершает это обещание заданным будущим, как только это будущее будет завершено.

returns

Это обещание

def ensuring(cond: (Promise[T]) => Boolean, msg: => Any): Promise[T]

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

def ensuring(cond: (Promise[T]) => Boolean): Promise[T]

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

def ensuring(cond: Boolean, msg: => Any): Promise[T]

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

def ensuring(cond: Boolean): Promise[T]

Неявный
Этот член добавлен неявным преобразованием из Promise[T] в Ensuring[Promise[T]] с помощью метода 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: AnyRef): Boolean

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

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

возвращает

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

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

def failure(cause: Throwable): Promise.this.type

Завершает обещание исключением.

cause

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

def finalize(): Unit

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

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

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

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

def formatted(fmtstr: String): String

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

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

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

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

возвращает

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

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

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 success(value: T): Promise.this.type

Завершает промис со значением.

value

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

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

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

def toString(): String

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

возвращает

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

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

def tryFailure(cause: Throwable): Boolean

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

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

возвращает

Если промис уже завершен, возвращает false, иначе true.

def trySuccess(value: T): Boolean

Пытается завершить промис со значением.

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

возвращает

Если промис уже завершен, возвращает false, иначе true.

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()

© 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/concurrent/Promise.html

Spec-Zone.ru

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