Package org.springframework.modulith.core

Class ApplicationModule

java.lang.Object
org.springframework.modulith.core.ApplicationModule
All Implemented Interfaces:
Comparable<ApplicationModule>
public class ApplicationModule extends Object implements Comparable<ApplicationModule>
An application module.
Author:
Oliver Drotbohm

  • Constructor Details

  • Method Details

    • getBasePackage

      public JavaPackage getBasePackage()
      Returns the module's base package.
      Returns:
      the basePackage

    • getNamedInterfaces

      public NamedInterfaces getNamedInterfaces()
      Returns all NamedInterfaces exposed by the module.
      Returns:
      the namedInterfaces will never be null.

    • getName

      @Deprecated public String getName()
      Deprecated.
      since 1.3, use getIdentifier() instead.
      Returns the logical name of the module.
      Returns:
      will never be null or empty.

    • getIdentifier

      public ApplicationModuleIdentifier getIdentifier()
      Returns the logical identifier of the module.
      Returns:
      will never be null.
      Since:
      1.3

    • getDisplayName

      public String getDisplayName()
      Returns the name of the ApplicationModule for display purposes.
      Returns:
      will never be null or empty.

    • getDependencies

      @Deprecated public ApplicationModuleDependencies getDependencies(ApplicationModules modules, DependencyType... type)
      Deprecated.
      since 1.3. Use getDirectDependencies(ApplicationModules, DependencyType...) instead.
      Returns ApplicationModule.AllowedDependencies of the current ApplicationModule.
      Parameters:
      modules - must not be null.
      type - must not be null.
      Returns:
      will never be null.

    • getDirectDependencies

      public ApplicationModuleDependencies getDirectDependencies(ApplicationModules modules, DependencyType... type)
      Returns the direct ApplicationModuleDependencies of the current ApplicationModule.
      Parameters:
      modules - must not be null.
      type - must not be null.
      Returns:
      will never be null.

    • getAllDependencies

      public ApplicationModuleDependencies getAllDependencies(ApplicationModules modules, DependencyType... type)
      Returns the all ApplicationModuleDependencies (including transitive ones) of the current ApplicationModule.
      Parameters:
      modules - must not be null.
      type - must not be null.
      Returns:
      will never be null.

    • getEventsListenedTo

      public List<com.tngtech.archunit.core.domain.JavaClass> getEventsListenedTo(ApplicationModules modules)
      Returns all event types the current module exposes an event listener for.
      Parameters:
      modules - must not be null.
      Returns:

    • getPublishedEvents

      public List<EventType> getPublishedEvents()
      Returns all EventTypes published by the module.
      Returns:
      will never be null.

    • getValueTypes

      public List<com.tngtech.archunit.core.domain.JavaClass> getValueTypes()
      Returns all value types contained in the module.
      Returns:
      will never be null.

    • getAggregateRoots

      public List<com.tngtech.archunit.core.domain.JavaClass> getAggregateRoots()
      Returns all types that are considered aggregate roots.
      Returns:
      will never be null.

    • getBootstrapDependencies

      public Stream<ApplicationModule> getBootstrapDependencies(ApplicationModules modules)
      Returns all modules that contain types which the types of the current module depend on.
      Parameters:
      modules - must not be null.
      Returns:

    • getBootstrapDependencies

      public Stream<ApplicationModule> getBootstrapDependencies(ApplicationModules modules, DependencyDepth depth)

    • getBootstrapBasePackages

      public Stream<JavaPackage> getBootstrapBasePackages(ApplicationModules modules, DependencyDepth depth)
      Returns all JavaPackage for the current module including the ones by its dependencies.
      Parameters:
      modules - must not be null.
      depth - must not be null.
      Returns:

    • getSpringBeans

      public List<SpringBean> getSpringBeans()
      Returns all SpringBeans contained in the module.
      Returns:
      will never be null.

    • getSpringBeans

      public List<SpringBean> getSpringBeans(Class<?> type)
      Returns all SpringBeans assignable to the given type.
      Parameters:
      type - must not be null.
      Returns:
      will never be null.
      Since:
      1.4

    • getArchitecturallyEvidentType

      public ArchitecturallyEvidentType getArchitecturallyEvidentType(Class<?> type)
      Returns the ArchitecturallyEvidentType for the given type.
      Parameters:
      type - must not be null.
      Returns:
      will never be null.
      Throws:
      IllegalArgumentException - if the given type is not a module type.

    • contains

      public boolean contains(com.tngtech.archunit.core.domain.JavaClass type)
      Returns whether the current module contains the given type.
      Parameters:
      type - must not be null.

    • contains

      public boolean contains(Class<?> type)
      Returns whether the current module contains the given type.
      Parameters:
      type - must not be null.

    • getType

      public Optional<com.tngtech.archunit.core.domain.JavaClass> getType(String candidate)
      Returns the JavaClass for the given candidate simple or fully-qualified type name.
      Parameters:
      candidate - must not be null or empty.
      Returns:
      will never be null.

    • isExposed

      public boolean isExposed(com.tngtech.archunit.core.domain.JavaClass type)
      Returns whether the given JavaClass is exposed by the current module, i.e. whether it's part of any of the module's named interfaces.
      Parameters:
      type - must not be null.

    • isExposed

      public boolean isExposed(Class<?> type)
      Returns whether the given JavaClass is exposed by the current module, i.e. whether it's part of any of the module's named interfaces.
      Parameters:
      type - must not be null.
      Since:
      1.2.8, 1.3.2

    • verifyDependencies

      public void verifyDependencies(ApplicationModules modules)

    • detectDependencies

      public Violations detectDependencies(ApplicationModules modules)

    • isRootModule

      public boolean isRootModule()
      Returns whether the module is considered a root one, i.e., it is an artificial one created for each base package configured.
      Returns:
      whether the module is considered a root one.
      Since:
      1.1

    • contains

      public boolean contains(String candidate)
      Returns whether the given module contains a type with the given simple or fully qualified name.
      Parameters:
      candidate - must not be null.
      Since:
      1.3

    • toString

      public String toString(@Nullable ApplicationModules modules)

    • hasBasePackage

      boolean hasBasePackage(String candidate)
      Returns whether the module has a base package with the given name.
      Parameters:
      candidate - must not be null or empty.
      Returns:
      whether the module has a base package with the given name.
      Since:
      1.1

    • getSpringBeansInternal

      Classes getSpringBeansInternal()

    • getAllowedDependencies

      public ApplicationModule.AllowedDependencies getAllowedDependencies(ApplicationModules modules)
      Returns all declared allowed module dependencies, either explicitly declared or defined as shared on the given ApplicationModules instance.
      Parameters:
      modules - must not be null.
      Returns:
      will never be null.
      Since:
      1.4.2, previously package private

    • containsPackage

      boolean containsPackage(String packageName)
      Returns whether the ApplicationModule contains the package with the given name, which means the given package is either the module's base package or a sub package of it.
      Parameters:
      packageName - must not be null or empty.
      Returns:
      whether the ApplicationModule contains the package with the given name.
      Since:
      1.0.2

    • isOpen

      public boolean isOpen()
      Returns whether the module is considered open.
      Since:
      1.4.2, previously package private since 1.2.
      See Also:

    • containsTypeInAnyParent

      boolean containsTypeInAnyParent(com.tngtech.archunit.core.domain.JavaClass type, ApplicationModules modules)
      Returns whether the given type is contained in any of the parent modules of the current one.
      Parameters:
      type - must not be null.
      modules - must not be null.
      Since:
      1.3

    • getDependencies

      public ApplicationModuleDependencies getDependencies(ApplicationModules modules, DependencyDepth depth, DependencyType... types)

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • compareTo

      public int compareTo(ApplicationModule o)
      Specified by:
      compareTo in interface Comparable<ApplicationModule>

    • getParentModule

      Optional<ApplicationModule> getParentModule(ApplicationModules modules)
      Returns the current module's immediate parent module, if present.
      Parameters:
      modules - must not be null.
      Returns:
      will never be null.
      Since:
      1.3

    • getDirectlyNestedModules

      Collection<ApplicationModule> getDirectlyNestedModules(ApplicationModules modules)
      Returns the ApplicationModules directly nested inside the current one.
      Parameters:
      modules - must not be null.
      Returns:
      will never be null.
      Since:
      1.3

    • getNestedModules

      Collection<ApplicationModule> getNestedModules(ApplicationModules modules)
      Returns all of the current ApplicationModule's nested ApplicationModules including ones contained in nested modules in turn.
      Parameters:
      modules - must not be null.
      Returns:
      will never be null.
      Since:
      1.3

    • getClasses

      Classes getClasses()
      Returns:
      the classes

    • getInternalTypes

      public Collection<com.tngtech.archunit.core.domain.JavaClass> getInternalTypes()
      Returns all types internal to the module.
      Returns:
      will never be null.
      Since:
      1.4