Spec-Zone.ru › Scala 2.12 Library

Трейт scala.concurrent.Awaitable

trait Awaitable[+T] extends AnyRef

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

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

Source
Awaitable.scala
Линейные супертипы
Известные подклассы

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

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

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

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

atMost

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

returns

этот Awaitable

Annotations
@throws( clazz = classOf[TimeoutException] ) @throws( clazz = 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 для неограниченного ожидания или конечного положительного интервала

returns

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

Annotations
@throws( clazz = classOf[TimeoutException] ) @throws( clazz = classOf[InterruptedException] )
Исключения

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

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

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

Члены конкретных значений

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

Неявный
Этот член добавляется неявным преобразованием из Awaitable[T] в any2stringadd[Awaitable[T]] с помощью метода any2stringadd в scala.Predef.
Определяющие классы
any2stringadd

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

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

Неявный
Этот член добавляется неявным преобразованием из Awaitable[T] в Ensuring[Awaitable[T]] с помощью метода Ensuring в scala.Predef.
Определяющие классы
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 реализует отношение эквивалентности для непустых экземпляров 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).

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

final def ne(arg0: AnyRef): Boolean

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

возвращает

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

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

final def notify(): Unit

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

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

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

final def notifyAll(): Unit

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

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

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

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

Definition Classes
AnyRef

def toString(): String

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

возвращает

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

Definition Classes
AnyRef → Any

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): (Awaitable[T], B)

Неявный
Этот член добавлен неявным преобразованием из Awaitable[T] в ArrowAssoc[Awaitable[T]] выполненным методом ArrowAssoc в scala.Predef.
Definition Classes
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/Awaitable.html

Spec-Zone.ru

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