Package org.springframework.modulith.core

Class ApplicationModuleInformationFactory.SpringModulithModule

java.lang.Object

org.springframework.modulith.core.ApplicationModuleInformationFactory.SpringModulithModule

All Implemented Interfaces:

ApplicationModuleInformation

Enclosing class:

ApplicationModuleInformationFactory

static class ApplicationModuleInformationFactory.SpringModulithModule
extends Object
implements ApplicationModuleInformation

An ApplicationModuleInformation that inspects the ApplicationModule annotation.

Author:

Oliver Drotbohm

Constructor Summary

Constructors

Constructor	Description
SpringModulithModule(ApplicationModuleInformationFactory.AnnotationLookup lookup)	Creates a new ApplicationModuleInformationFactory.SpringModulithModule for the given ApplicationModuleInformationFactory.AnnotationLookup.

Method Summary

Modifier and Type	Method	Description
List<String>	getDeclaredDependencies()	Returns all allowed dependencies.
Optional<String>	getDisplayName()	Returns the display name to be used to describe the module.
boolean	isOpen()	Returns whether the module is considered open.
static boolean	supports(ApplicationModuleInformationFactory.AnnotationLookup lookup)	Whether the given ApplicationModuleInformationFactory.AnnotationLookup 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(ApplicationModuleInformationFactory.AnnotationLookup lookup)

Creates a new ApplicationModuleInformationFactory.SpringModulithModule for the given ApplicationModuleInformationFactory.AnnotationLookup.

Parameters:

lookup - must not be null.

Method Details

supports

public static boolean supports(ApplicationModuleInformationFactory.AnnotationLookup lookup)

Whether the given ApplicationModuleInformationFactory.AnnotationLookup supports this ApplicationModuleInformation.

Parameters:

lookup - 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.

getDeclaredDependencies

public List<String> getDeclaredDependencies()

Description copied from interface: ApplicationModuleInformation

Returns all allowed dependencies.

Specified by:

getDeclaredDependencies in interface ApplicationModuleInformation

Returns:

will never be null.

isOpen

public boolean isOpen()

Description copied from interface: ApplicationModuleInformation

Returns whether the module is considered open.

Specified by:

isOpen in interface ApplicationModuleInformation

See Also:

• ApplicationModule.Type