Spec-Zone.ru › Scala 2.13 Library

Трейт scala.concurrent.Awaitable

trait Awaitable[+T] extends AnyRef

Объект, который может быть в конечном итоге завершён значением результата типа T, которое может быть ожидаемо с помощью блокирующих методов.

Объект Await предоставляет методы, которые позволяют получить результат Awaitable путём блокирования текущего потока до тех пор, пока Awaitable не будет завершено или не наступит таймаут.

Source
Awaitable.scala
Линейные надтипы
AnyRef, Any
Известные подклассы
Future, never

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

abstract def ready(atMost: Duration)(implicit permit: CanAwait): Awaitable.this.type

Ожидание состояния "завершён" этого Awaitable.

Этот метод не должен вызываться напрямую; используйте Await.ready вместо этого.

atMost

максимальное время ожидания, которое может быть отрицательным (ожидание не выполняется), Duration.Inf для неограниченного ожидания или конечной положительной продолжительности

возвращает

это Awaitable

Аннотации
@throws(classOf[TimeoutException]) @throws(classOf[InterruptedException])
Исключения

IllegalArgumentException, если atMost равно Duration.Undefined

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

TimeoutException, если после ожидания в течение указанного времени этот Awaitable всё ещё не готов

abstract def result(atMost: Duration)(implicit permit: CanAwait): T

Ожидание и возврат результата (типа T) этого Awaitable.

Этот метод не должен вызываться напрямую; используйте Await.result вместо этого.

atMost

максимальное время ожидания, которое может быть отрицательным (ожидание не выполняется), Duration.Inf для неограниченного ожидания или конечной положительной продолжительности

возвращает

значение результата, если Awaitable завершается в течение указанного максимального времени ожидания

Аннотации
@throws(classOf[Exception])
Исключения

IllegalArgumentException, если atMost равно Duration.Undefined

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

TimeoutException, если после ожидания в течение указанного времени этот Awaitable всё ещё не готов

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

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

Implicit
Этот член добавлен с помощью неявного преобразования из Awaitable[T] вany2stringadd[Awaitable[T]], выполненного методом any2stringadd в scala.Predef.
Definition Classes
any2stringadd

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

Implicit
Этот член добавлен с помощью неявного преобразования из Awaitable[T] вArrowAssoc[Awaitable[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 ensuring(cond: (Awaitable[T]) => Boolean, msg: => Any): Awaitable[T]

Implicit
Этот член добавлен с помощью неявного преобразования из Awaitable[T] вEnsuring[Awaitable[T]], выполненного методом Ensuring в scala.Predef.
Definition Classes
Ensuring

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

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

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

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

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

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

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

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

возвращает

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

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

def finalize(): Unit

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

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

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

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

def formatted(fmtstr: String): String

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

Неявный
Этот член добавлен неявным преобразованием из Awaitable[T] в StringFormat[Awaitable[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

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

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

def toString(): String

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

возвращает

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

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

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/Awaitable.html

Spec-Zone.ru

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