Package org.apache.pekko.actor.testkit.typed.javadsl

Class ActorTestKit$

java.lang.Object
org.apache.pekko.actor.testkit.typed.javadsl.ActorTestKit$
public class ActorTestKit$ extends Object

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActorTestKit$()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.typesafe.config.Config
    applicationTestConfig()
    Config loaded from application-test.conf, which is used if no specific config is given.
    ActorTestKit
    create()
    Create a testkit named from the ActorTestKit class.
    ActorTestKit
    create(com.typesafe.config.Config customConfig)
    Create a testkit named from the ActorTestKit class, and use a custom config for the actor system.
    ActorTestKit
    create(String name)
    Create a testkit using the provided name.
    ActorTestKit
    create(String name, com.typesafe.config.Config customConfig)
    Create a test kit named based on the provided name, and uses the provided custom config for the actor system.
    ActorTestKit
    create(String name, com.typesafe.config.Config customConfig, TestKitSettings settings)
    Create an pekko.actor.typed.ActorSystem named based on the provided name, use the provided custom config for the actor system, and the testkit will use the provided setting.
    ActorTestKit
    create(ActorSystem<?> system)
    Create a testkit from the provided actor system.
    void
    shutdown(ActorSystem<?> system)
    Shutdown the given pekko.actor.typed.ActorSystem and block until it shuts down, if more time than system-shutdown-default passes an exception is thrown (can be configured with throw-on-shutdown-timeout).
    void
    shutdown(ActorSystem<?> system, Duration duration)
    Shutdown the given pekko.actor.typed.ActorSystem and block until it shuts down, if more time than system-shutdown-default passes an exception is thrown (can be configured with throw-on-shutdown-timeout).
    void
    shutdown(ActorSystem<?> system, Duration duration, boolean throwIfShutdownTimesOut)
    Shutdown the given actor system and wait up to duration for shutdown to complete.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • MODULE$

      public static final ActorTestKit$ MODULE$
      Static reference to the singleton instance of this Scala object.

  • Constructor Details

    • ActorTestKit$

      public ActorTestKit$()

  • Method Details

    • create

      public ActorTestKit create()
      Create a testkit named from the ActorTestKit class.

      When the test has completed you should terminate the ActorSystem and the testkit with ActorTestKit.shutdownTestKit().

      Config loaded from application-test.conf if that exists, otherwise using default configuration from the reference.conf resources that ship with the Akka libraries. The application.conf of your project is not used in this case.

    • create

      public ActorTestKit create(ActorSystem<?> system)
      Create a testkit from the provided actor system.

      When the test has completed you should terminate the ActorSystem and the testkit with ActorTestKit.shutdownTestKit().

      Config loaded from the provided actor if that exists, otherwise using default configuration from the reference.conf resources that ship with the Akka libraries.

    • create

      public ActorTestKit create(String name)
      Create a testkit using the provided name.

      It will create an pekko.actor.typed.ActorSystem with this name, e.g. threads will include the name. When the test has completed you should terminate the ActorSystem and the testkit with ActorTestKit.shutdownTestKit().

      Config loaded from application-test.conf if that exists, otherwise using default configuration from the reference.conf resources that ship with the Akka libraries. The application.conf of your project is not used in this case.

    • create

      public ActorTestKit create(com.typesafe.config.Config customConfig)
      Create a testkit named from the ActorTestKit class, and use a custom config for the actor system.

      It will also used the provided customConfig provided to create the ActorSystem

      When the test has completed you should terminate the ActorSystem and the testkit with ActorTestKit.shutdownTestKit().

    • create

      public ActorTestKit create(String name, com.typesafe.config.Config customConfig)
      Create a test kit named based on the provided name, and uses the provided custom config for the actor system.

      It will create an pekko.actor.typed.ActorSystem with this name, e.g. threads will include the name.

      It will also used the provided customConfig provided to create the ActorSystem

      When the test has completed you should terminate the ActorSystem and the testkit with ActorTestKit.shutdownTestKit().

    • create

      public ActorTestKit create(String name, com.typesafe.config.Config customConfig, TestKitSettings settings)
      Create an pekko.actor.typed.ActorSystem named based on the provided name, use the provided custom config for the actor system, and the testkit will use the provided setting.

      It will create an pekko.actor.typed.ActorSystem with this name, e.g. threads will include the name.

      It will also used the provided customConfig provided to create the ActorSystem, and provided setting.

      When the test has completed you should terminate the ActorSystem and the testkit with ActorTestKit.shutdownTestKit().

    • shutdown

      public void shutdown(ActorSystem<?> system, Duration duration, boolean throwIfShutdownTimesOut)
      Shutdown the given actor system and wait up to duration for shutdown to complete.
      Parameters:
      throwIfShutdownTimesOut - Fail the test if the system fails to shut down, if false an error is printed to stdout when the system did not shutdown but no exception is thrown.

    • shutdown

      public void shutdown(ActorSystem<?> system, Duration duration)
      Shutdown the given pekko.actor.typed.ActorSystem and block until it shuts down, if more time than system-shutdown-default passes an exception is thrown (can be configured with throw-on-shutdown-timeout).

    • shutdown

      public void shutdown(ActorSystem<?> system)
      Shutdown the given pekko.actor.typed.ActorSystem and block until it shuts down, if more time than system-shutdown-default passes an exception is thrown (can be configured with throw-on-shutdown-timeout).

    • applicationTestConfig

      public com.typesafe.config.Config applicationTestConfig()
      Config loaded from application-test.conf, which is used if no specific config is given.