c

akka.testkit

ErrorFilter

final case class ErrorFilter(throwable: Class[_], source: Option[String], message: Either[String, Regex], complete: Boolean)(occurrences: Int) extends EventFilter with Product with Serializable

Filter which matches Error events, if they satisfy the given criteria:

  • throwable applies an upper bound on the type of exception contained in the Error event
  • source, if given, applies a filter on the event’s origin
  • message applies a filter on the event’s message (either with String.startsWith or Regex.findFirstIn().isDefined); if the message itself does not match, the match is retried with the contained Exception’s message; if both are null, the filter always matches if at the same time the Exception’s stack trace is empty (this catches JVM-omitted “fast-throw” exceptions)

If you want to match all Error events, the most efficient is to use Left("").

Source
TestEventListener.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ErrorFilter
  2. Serializable
  3. Product
  4. Equals
  5. EventFilter
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ErrorFilter(throwable: Class[_])

    Java API: filter only on the given type of exception

  2. new ErrorFilter(throwable: Class[_], source: String, message: String, pattern: Boolean, complete: Boolean, occurrences: Int)

    Java API: create an ErrorFilter

    Java API: create an ErrorFilter

    source

    apply this filter only to events from the given source; do not filter on source if this is given as null

    message

    apply this filter only to events whose message matches; do not filter on message if this is given as null

    pattern

    if false, the message string must start with the given string, otherwise the message argument is treated as regular expression which is matched against the message (may match only a substring to filter)

    complete

    whether the event’s message must match the given message string or pattern completely

  3. new ErrorFilter(throwable: Class[_], source: Option[String], message: Either[String, Regex], complete: Boolean)(occurrences: Int)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ErrorFilter toany2stringadd[ErrorFilter] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ErrorFilter, B)
    Implicit
    This member is added by an implicit conversion from ErrorFilter toArrowAssoc[ErrorFilter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def apply(event: LogEvent): Boolean
    Definition Classes
    EventFilter
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def assertDone(max: Duration): Unit

    Assert that this filter has matched as often as requested by its occurrences parameter specifies.

    Assert that this filter has matched as often as requested by its occurrences parameter specifies.

    Definition Classes
    EventFilter
  9. def awaitDone(max: Duration): Boolean
    Definition Classes
    EventFilter
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. val complete: Boolean
    Definition Classes
    ErrorFilterEventFilter
  12. def doMatch(src: String, msg: Any): Boolean

    internal implementation helper, no guaranteed API

    internal implementation helper, no guaranteed API

    Attributes
    protected
    Definition Classes
    EventFilter
  13. def ensuring(cond: (ErrorFilter) => Boolean, msg: => Any): ErrorFilter
    Implicit
    This member is added by an implicit conversion from ErrorFilter toEnsuring[ErrorFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (ErrorFilter) => Boolean): ErrorFilter
    Implicit
    This member is added by an implicit conversion from ErrorFilter toEnsuring[ErrorFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): ErrorFilter
    Implicit
    This member is added by an implicit conversion from ErrorFilter toEnsuring[ErrorFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): ErrorFilter
    Implicit
    This member is added by an implicit conversion from ErrorFilter toEnsuring[ErrorFilter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def intercept[T](code: => T)(implicit system: ActorSystem): T

    Apply this filter while executing the given code block.

    Apply this filter while executing the given code block. Care is taken to remove the filter when the block is finished or aborted.

    Definition Classes
    EventFilter
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def matches(event: LogEvent): Boolean

    This method decides whether to filter the event (true) or not (false).

    This method decides whether to filter the event (true) or not (false).

    Definition Classes
    ErrorFilterEventFilter
  22. val message: Either[String, Regex]
    Definition Classes
    ErrorFilterEventFilter
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def productElementNames: Iterator[String]
    Definition Classes
    Product
  27. val source: Option[String]
    Definition Classes
    ErrorFilterEventFilter
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. val throwable: Class[_]
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ErrorFilter toStringFormat[ErrorFilter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (ErrorFilter, B)
    Implicit
    This member is added by an implicit conversion from ErrorFilter toArrowAssoc[ErrorFilter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from EventFilter

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromErrorFilter to any2stringadd[ErrorFilter]

Inherited by implicit conversion StringFormat fromErrorFilter to StringFormat[ErrorFilter]

Inherited by implicit conversion Ensuring fromErrorFilter to Ensuring[ErrorFilter]

Inherited by implicit conversion ArrowAssoc fromErrorFilter to ArrowAssoc[ErrorFilter]

Ungrouped