Module spring.modulith.test
Package org.springframework.modulith.test

Class ModuleTestExecution

java.lang.Object
org.springframework.modulith.test.ModuleTestExecution
All Implemented Interfaces:
Iterable<org.springframework.modulith.core.ApplicationModule>
public class ModuleTestExecution extends Object implements Iterable<org.springframework.modulith.core.ApplicationModule>
Author:
Oliver Drotbohm, Lukas Dohmen

  • Method Details

    • of

      public static Supplier<ModuleTestExecution> of(Class<?> type)

    • getBasePackages

      public org.springframework.modulith.core.JavaPackages getBasePackages()
      Returns all base packages the current execution needs to use for component scanning, auto-configuration etc.
      Returns:

    • includes

      public boolean includes(String className)

    • getDependencies

      public List<org.springframework.modulith.core.ApplicationModule> getDependencies()
      Returns all module dependencies, based on the current ApplicationModuleTest.BootstrapMode.
      Returns:

    • verify

      public void verify()
      Explicitly trigger the module structure verification.

    • verifyModule

      public void verifyModule()
      Verifies the setup of the module bootstrapped by this execution.

    • getBootstrapMode

      public ApplicationModuleTest.BootstrapMode getBootstrapMode()
      Returns the ApplicationModuleTest.BootstrapMode to be used for the executions.
      Returns:
      will never be null.

    • getModule

      public org.springframework.modulith.core.ApplicationModule getModule()
      Returns the primary ApplicationModule to bootstrap.
      Returns:
      the module will never be null.

    • getModules

      public org.springframework.modulith.core.ApplicationModules getModules()
      Returns all ApplicationModules of the application.
      Returns:
      the modules will never be null.

    • getExtraIncludes

      public List<org.springframework.modulith.core.ApplicationModule> getExtraIncludes()
      Returns all ApplicationModules registered as extra includes for the execution.
      Returns:
      the extraIncludes will never be null.

    • isIncludedInExecution

      public boolean isIncludedInExecution(org.springframework.modulith.core.ApplicationModuleIdentifier identifier)
      Returns whether the module with the given identifier is included in the current execution.
      Parameters:
      identifier - must not be null.
      Since:
      2.0

    • iterator

      public Iterator<org.springframework.modulith.core.ApplicationModule> iterator()
      Specified by:
      iterator in interface Iterable<org.springframework.modulith.core.ApplicationModule>

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object