CanManage

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

Abstract Value Members

abstract 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
abstract 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

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from CanManage[R] to any2stringadd[CanManage[R]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
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 ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
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 Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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( ... )
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 ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object CanManage | package arm

trait CanManage[-R] extends AnyRef

Abstract Value Members

abstract def onException(r: R): Unit

abstract def onFinally(r: R): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

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

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

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

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

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

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped