io.udash.utils.CallbacksHandler.scala Maven / Gradle / Ivy

Go to download
package io.udash.utils

import io.udash.logging.CrossLogging

import scala.collection.mutable
import scala.util.{Failure, Try}

/**
 * Helper class for callbacks handling.
 * The callbacks are executed in order of registration.
 * Each callback is executed once, it swallows exceptions thrown in callbacks.
 */
final class CallbacksHandler[ItemType] extends CrossLogging {
  type CallbackType = PartialFunction[ItemType, Any]

  private val callbacks: mutable.Set[CallbackType] = mutable.LinkedHashSet.empty

  /** Registers callback and returns `Registration`.
   * Registration operations don't preserve callbacks order. */
  def register(callback: CallbackType): Registration = callbacks.synchronized {
    callbacks += callback
    new SetRegistration(callbacks, callback)
  }

  /** Calls each registered callback and swallows exceptions thrown in callbacks. */
  def fire(item: ItemType): Unit = {
    callbacks.synchronized {
      callbacks.toArray
    }.foreach { pf =>
      /* From PF docs:
       * Note that expression `pf.applyOrElse(x, default)` is equivalent to
       *  {{{ if(pf isDefinedAt x) pf(x) else default(x) }}}
       * except that `applyOrElse` method can be implemented more efficiently.
       */
      Try(pf.applyOrElse(item, (_: ItemType) => ())) match {
        case Failure(ex) => logger.error("Exception thrown in callback.", ex)
        case _ => // ignore
      }
    }
  }

  /** Returns current number of registered callbacks. */
  def size: Int = callbacks.synchronized(callbacks.size)
}