Package org.springframework.modulith.core

Class ApplicationModuleInformation.SpringModulithModule

java.lang.Object

org.springframework.modulith.core.ApplicationModuleInformation.SpringModulithModule

All Implemented Interfaces:

ApplicationModuleInformation

Enclosing interface:

ApplicationModuleInformation

public static class ApplicationModuleInformation.SpringModulithModule
extends Object
implements ApplicationModuleInformation

An ApplicationModuleInformation that inspects the ApplicationModule annotation.

Author:

Oliver Drotbohm

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.modulith.core.ApplicationModuleInformation

ApplicationModuleInformation.JMoleculesModule, ApplicationModuleInformation.SpringModulithModule

Constructor Summary

Constructors

Constructor	Description
SpringModulithModule(JavaPackage javaPackage)	Creates a new ApplicationModuleInformation.SpringModulithModule for the given JavaPackage.

Method Summary

Modifier and Type	Method	Description
List<String>	getAllowedDependencies()	Returns all allowed dependencies.
Optional<String>	getDisplayName()	Returns the display name to be used to describe the module.
static boolean	supports(JavaPackage javaPackage)	Whether the given JavaPackage supports this ApplicationModuleInformation.

Methods inherited from class java.lang.Object

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

Constructor Details

SpringModulithModule

public SpringModulithModule(JavaPackage javaPackage)

Creates a new ApplicationModuleInformation.SpringModulithModule for the given JavaPackage.

Parameters:

javaPackage - must not be null.

Method Details

supports

public static boolean supports(JavaPackage javaPackage)

Whether the given JavaPackage supports this ApplicationModuleInformation.

Parameters:

javaPackage - must not be null.

getDisplayName

public Optional<String> getDisplayName()

Description copied from interface: ApplicationModuleInformation

Returns the display name to be used to describe the module.

Specified by:

getDisplayName in interface ApplicationModuleInformation

Returns:

will never be null.

getAllowedDependencies

public List<String> getAllowedDependencies()

Description copied from interface: ApplicationModuleInformation

Returns all allowed dependencies.

Specified by:

getAllowedDependencies in interface ApplicationModuleInformation

Returns:

will never be null.