Spec-Zone.ru › Scala 2.12 Library

Трейт scala.concurrent.Promise

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

Трейт Promise[T] extends AnyRef

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

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

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

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

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

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

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

возвращает

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

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

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

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

возвращает

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

Члены-значения

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 +(other: String): String

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

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

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

final def ==(arg0: Any): Boolean

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

возвращает

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

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

final def asInstanceOf[T0]: T0

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

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

возвращает

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

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

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

def clone(): AnyRef

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

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

возвращает

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

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

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

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

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

result

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

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

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

возвращает

Это обещание

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: Any): 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[lang]
Классы определения
AnyRef
Аннотации
@throws( classOf[java.lang.Throwable] )
Примечание

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

def formatted(fmtstr: String): String

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

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

final def getClass(): Class[_]

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

возвращает

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

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

def hashCode(): Int

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

returns

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

Definition Classes
AnyRef → Any
Annotations
@native()

final def isInstanceOf[T0]: Boolean

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

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

returns

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

Definition Classes
Any

final def ne(arg0: AnyRef): Boolean

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

returns

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

Definition Classes
AnyRef

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

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

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

def success(value: T): Promise.this.type

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

value

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

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

Definition Classes
AnyRef

def toString(): String

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

returns

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

Definition Classes
AnyRef → Any

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

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

returns

Это обещание

def tryFailure(cause: Throwable): Boolean

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

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

returns

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

def trySuccess(value: T): Boolean

Попытка завершить обещание значением.

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

returns

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

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

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

Definition Classes
AnyRef
Annotations
@throws( ... )

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

def →[B](y: B): (Promise[T], B)

Неявный
Этот член добавлен с помощью неявного преобразования из Promise[T] в ArrowAssoc[Promise[T]], выполненного методом 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/concurrent/Promise.html

Spec-Zone.ru

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