Package org.apache.pekko.testkit

Class EventFilter$

java.lang.Object

org.apache.pekko.testkit.EventFilter$

public class EventFilter$
extends Object

Facilities for selectively filtering out expected events from logging so that you can keep your test run’s console output clean and do not miss real error messages.

'''Also have a look at the org.apache.pekko.testkit package object’s filterEvents and filterException methods.'''

The source filters do accept Class[_] arguments, matching any object which is an instance of the given class, e.g.

 EventFilter.info(source = classOf[MyActor]) // will match Info events from any MyActor instance
 

The message object will be converted to a string before matching ("null" if it is null).

Field Summary

Fields

Modifier and Type	Field	Description
static final EventFilter$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
EventFilter$()

Method Summary

Modifier and Type	Method	Description
<A extends Throwable> EventFilter	apply(String message, String source, String start, String pattern, int occurrences, scala.reflect.ClassTag<A> evidence$1)	Create a filter for Error events.
<A extends Throwable> String	apply$default$1()
<A extends Throwable> String	apply$default$2()
<A extends Throwable> String	apply$default$3()
<A extends Throwable> String	apply$default$4()
<A extends Throwable> int	apply$default$5()
EventFilter	custom(scala.PartialFunction<Logging.LogEvent,Object> test, int occurrences)	Create a custom event filter.
int	custom$default$2()
EventFilter	debug(String message, String source, String start, String pattern, int occurrences)	Create a filter for Debug events.
String	debug$default$1()
String	debug$default$2()
String	debug$default$3()
String	debug$default$4()
int	debug$default$5()
EventFilter	error(String message, String source, String start, String pattern, int occurrences)	Create a filter for Error events.
String	error$default$1()
String	error$default$2()
String	error$default$3()
String	error$default$4()
int	error$default$5()
EventFilter	info(String message, String source, String start, String pattern, int occurrences)	Create a filter for Info events.
String	info$default$1()
String	info$default$2()
String	info$default$3()
String	info$default$4()
int	info$default$5()
EventFilter	warning(String message, String source, String start, String pattern, int occurrences)	Create a filter for Warning events.
String	warning$default$1()
String	warning$default$2()
String	warning$default$3()
String	warning$default$4()
int	warning$default$5()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE$

public static final EventFilter$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

EventFilter$

public EventFilter$()

Method Details

apply

public <A extends Throwable> EventFilter apply(String message,
 String source,
 String start,
 String pattern,
 int occurrences,
 scala.reflect.ClassTag<A> evidence$1)

Create a filter for Error events. Give up to one of start and pattern:

 EventFilter[MyException]()                                         // filter only on exception type
 EventFilter[MyException]("message")                                // filter on exactly matching message
 EventFilter[MyException](source = obj)                             // filter on event source
 EventFilter[MyException](start = "Expected")                       // filter on start of message
 EventFilter[MyException](source = obj, pattern = "weird.*message") // filter on pattern and message
 

''Please note that filtering on the source being null does NOT work (passing null disables the source filter).''

apply$default$1

public <A extends Throwable> String apply$default$1()

apply$default$2

public <A extends Throwable> String apply$default$2()

apply$default$3

public <A extends Throwable> String apply$default$3()

apply$default$4

public <A extends Throwable> String apply$default$4()

apply$default$5

public <A extends Throwable> int apply$default$5()

error

public EventFilter error(String message,
 String source,
 String start,
 String pattern,
 int occurrences)

Create a filter for Error events. See apply() for more details.

error$default$1

public String error$default$1()

error$default$2

public String error$default$2()

error$default$3

public String error$default$3()

error$default$4

public String error$default$4()

error$default$5

public int error$default$5()

warning

public EventFilter warning(String message,
 String source,
 String start,
 String pattern,
 int occurrences)

Create a filter for Warning events. Give up to one of start and pattern:

 EventFilter.warning()                                         // filter only on warning event
 EventFilter.warning(source = obj)                             // filter on event source
 EventFilter.warning(start = "Expected")                       // filter on start of message
 EventFilter.warning(source = obj, pattern = "weird.*message") // filter on pattern and message
 

''Please note that filtering on the source being null does NOT work (passing null disables the source filter).''

warning$default$1

public String warning$default$1()

warning$default$2

public String warning$default$2()

warning$default$3

public String warning$default$3()

warning$default$4

public String warning$default$4()

warning$default$5

public int warning$default$5()

info

public EventFilter info(String message,
 String source,
 String start,
 String pattern,
 int occurrences)

Create a filter for Info events. Give up to one of start and pattern:

 EventFilter.info()                                         // filter only on info event
 EventFilter.info(source = obj)                             // filter on event source
 EventFilter.info(start = "Expected")                       // filter on start of message
 EventFilter.info(source = obj, pattern = "weird.*message") // filter on pattern and message
 

''Please note that filtering on the source being null does NOT work (passing null disables the source filter).''

info$default$1

public String info$default$1()

info$default$2

public String info$default$2()

info$default$3

public String info$default$3()

info$default$4

public String info$default$4()

info$default$5

public int info$default$5()

debug

public EventFilter debug(String message,
 String source,
 String start,
 String pattern,
 int occurrences)

Create a filter for Debug events. Give up to one of start and pattern:

 EventFilter.debug()                                         // filter only on debug type
 EventFilter.debug(source = obj)                             // filter on event source
 EventFilter.debug(start = "Expected")                       // filter on start of message
 EventFilter.debug(source = obj, pattern = "weird.*message") // filter on pattern and message
 

''Please note that filtering on the source being null does NOT work (passing null disables the source filter).''

debug$default$1

public String debug$default$1()

debug$default$2

public String debug$default$2()

debug$default$3

public String debug$default$3()

debug$default$4

public String debug$default$4()

debug$default$5

public int debug$default$5()

custom

public EventFilter custom(scala.PartialFunction<Logging.LogEvent,Object> test,
 int occurrences)

Create a custom event filter. The filter will affect those events for which the supplied partial function is defined and returns true.

 EventFilter.custom {
   case Warning(ref, "my warning") if ref == actor || ref == null => true
 }
 

custom$default$2

public int custom$default$2()