Packages

c

com.twitter.util

AbstractCloseAwaitably

abstract class AbstractCloseAwaitably extends AbstractClosable with Awaitable[BoxedUnit]

Java's analog of Scala's com.twitter.util.CloseAwaitably.

In order to make it more Java-friendly, the abstract method com.twitter.util.AbstractCloseAwaitably#onClose is used instead of a higher-order function in Scala version.

An example usage looks as follows.



  class A extends AbstractCloseAwaitably {
    public Future onClose(Time deadline) {
      return Future.Done();
    
  }

}

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractCloseAwaitably
  2. Awaitable
  3. AbstractClosable
  4. Closable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractCloseAwaitably()

Abstract Value Members

  1. abstract def isReady(implicit permit: CanAwait): Boolean

    Is this Awaitable ready? In other words: would calling Awaitable.ready block?

    Is this Awaitable ready? In other words: would calling Awaitable.ready block?

    Definition Classes
    Awaitable
  2. abstract def onClose(deadline: Time): Future[BoxedUnit]

    An on-close handler that is executed when this com.twitter.util.Closable is being closed.

  3. abstract def ready(timeout: Duration)(implicit permit: CanAwait): AbstractCloseAwaitably.this.type

    Support for Await.ready.

    Support for Await.ready. The use of the implicit permit is an access control mechanism: only Await.ready may call this method.

    Definition Classes
    Awaitable
    Annotations
    @throws( classOf[TimeoutException] ) @throws( classOf[InterruptedException] )
  4. abstract def result(timeout: Duration)(implicit permit: CanAwait): BoxedUnit

    Support for Await.result.

    Support for Await.result. The use of the implicit permit is an access control mechanism: only Await.result may call this method.

    Definition Classes
    Awaitable
    Annotations
    @throws( classOf[Exception] )

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def close(deadline: Time): Future[BoxedUnit]

    Definition Classes
    AbstractCloseAwaitablyClosable
    See also

    com.twitter.util.Closable#close()

  7. def close(after: Duration): Future[Unit]

    Close the resource with the given timeout.

    Close the resource with the given timeout. This timeout is advisory, giving the callee some leeway, for example to drain clients or finish up other tasks.

    Definition Classes
    Closable
  8. final def close(): Future[Unit]

    Close the resource.

    Close the resource. The returned Future is completed when the resource has been fully relinquished.

    Definition Classes
    Closable
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def isReady(permit: CanAwait): Boolean

    See also

    com.twitter.util.Awaitable#isReady(com.twitter.util.Awaitable.CanAwait)

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def ready(timeout: Duration, permit: CanAwait): Awaitable[BoxedUnit]

    See also

    com.twitter.util.Awaitable#ready(Duration, com.twitter.util.Awaitable.CanAwait)

  20. def result(timeout: Duration, permit: CanAwait): BoxedUnit

    See also

    com.twitter.util.Awaitable#result(Duration, com.twitter.util.Awaitable.CanAwait)

  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Awaitable[BoxedUnit]

Inherited from AbstractClosable

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped