io.tmos.arm

CanManage

trait CanManage[-R] extends AnyRef

For encapsulating the management logic of a resource.

Default logic for any java.lang.AutoClosable is provided by the companion object, which may be imported into current scope as implicits.

Other types may be provided in scope by the user. For example

import java.util.concurrent._
import io.tmos.arm.Implicits._

implicit val manager: CanManage[ExecutorService] = new CanManage[ExecutorService] {
  override def onFinally(pool: ExecutorService): Unit = {
    pool.shutdown() // Disable new tasks from being submitted
    try {
      if (!pool.awaitTermination(10, TimeUnit.SECONDS)) { // wait for normal termination
        pool.shutdownNow() // force terminate
        if (!pool.awaitTermination(10, TimeUnit.SECONDS)) // wait for forced termination
          throw new RuntimeException("ExecutorService did not terminate")
      }
    } catch {
      case _: InterruptedException =>
        pool.shutdownNow() // (Re-)Cancel if current thread also interrupted
        Thread.currentThread().interrupt() // Preserve interrupt status
    }
  }
  override def onException(r: ExecutorService): Unit = {}
}

for (manage(executorService) <- Executors.newSingleThreadExecutor.manage) { ... }
R

the type of the resource to manage

Linear Supertypes
AnyRef, Any
Known Subclasses
CloseOnException, CloseOnFinally
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. CanManage
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (CanManage[R], B)

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to ArrowAssoc[CanManage[R]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def ensuring(cond: (CanManage[R]) ⇒ Boolean, msg: ⇒ Any): CanManage[R]

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to Ensuring[CanManage[R]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (CanManage[R]) ⇒ Boolean): CanManage[R]

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to Ensuring[CanManage[R]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): CanManage[R]

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to Ensuring[CanManage[R]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): CanManage[R]

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to Ensuring[CanManage[R]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. def onException(r: R): Unit

    Execution hook called when an exception is thrown from the managed block.

    Execution hook called when an exception is thrown from the managed block. This is executed prior to [onFinally].

    Implementors are free to permit exceptions thrown from this method, however note that any new exceptions thrown will be added as a suppressed exception of the currently throwing exception. Thus it is strongly advised that implementors do not throw any exceptions if it would cause problems for an exception to be suppressed.

    r

    the resource being managed

  25. def onFinally(r: R): Unit

    Execution hook called after the managed block.

    Execution hook called after the managed block.

    This execution hook is called regardless if an exception is thrown.

    Usually resources are released or closed in the lifecycle.

    Implementors are free to permit exceptions thrown from this method, however it is strongly advised to not have the method throw java.lang.InterruptedException. This exception interacts with a thread's interrupted status, and runtime misbehavior is likely to occur if an java.lang.InterruptedException is suppressed. More generally, if it would cause problems for an exception to be suppressed, the AutoCloseable.close method should not throw it."

    r

    the resource being managed

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

    Definition Classes
    AnyRef

  27. def toString(): String

    Definition Classes
    AnyRef → Any

  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. def →[B](y: B): (CanManage[R], B)

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to ArrowAssoc[CanManage[R]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (canManage: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (canManage: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: CanManage[R]

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to ArrowAssoc[CanManage[R]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (canManage: ArrowAssoc[CanManage[R]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: CanManage[R]

    Implicit information
    This member is added by an implicit conversion from CanManage[R] to Ensuring[CanManage[R]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (canManage: Ensuring[CanManage[R]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from CanManage[R] to StringAdd

Inherited by implicit conversion any2stringfmt from CanManage[R] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from CanManage[R] to ArrowAssoc[CanManage[R]]

Inherited by implicit conversion any2Ensuring from CanManage[R] to Ensuring[CanManage[R]]

Ungrouped