Package org.springframework.modulith.core

Class ApplicationModuleSource

java.lang.Object

org.springframework.modulith.core.ApplicationModuleSource

public class ApplicationModuleSource
extends Object

The source of an ApplicationModule. Essentially a JavaPackage and associated naming strategy for the module. This will be used when constructing sources from a base package and an ApplicationModuleDetectionStrategy so that the names of the module to be created for the detected packages become the trailing name underneath the base package. For example, scanning from com.acme, an ApplicationModule located in com.acme.foo.bar would be named foo.bar.

Since:

1.3

Author:

Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	ApplicationModuleSource.ApplicationModuleSourceMetadata	An intermediate abstraction to detect both the ApplicationModuleIdentifier and potentially nested module declarations for the JavaPackages returned from the first pass of module detection.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object obj)
(package private) static ApplicationModuleSource	from(JavaPackage pkg, String identifier)	Creates a new ApplicationModuleSource for the given JavaPackage and name.
static Stream<ApplicationModuleSource>	from(JavaPackage rootPackage, ApplicationModuleDetectionStrategy strategy, boolean fullyQualifiedModuleNames)	Returns a Stream of ApplicationModuleSources by applying the given ApplicationModuleDetectionStrategy to the given base package.
(package private) ApplicationModuleIdentifier	getIdentifier()	Returns the ApplicationModuleIdentifier to be used for the module.
(package private) JavaPackage	getModuleBasePackage()	Returns the base package for the module.
(package private) NamedInterfaces	getNamedInterfaces(ApplicationModuleInformation information)	Returns all NamedInterfaces for the given ApplicationModuleInformation.
(package private) NamedInterfaces	getNamedInterfaces(ApplicationModuleInformation information, JavaPackage basePackage)	Returns all NamedInterfaces for the given ApplicationModuleInformation and a customized JavaPackage.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

from

public static Stream<ApplicationModuleSource> from(JavaPackage rootPackage,
 ApplicationModuleDetectionStrategy strategy,
 boolean fullyQualifiedModuleNames)

Returns a Stream of ApplicationModuleSources by applying the given ApplicationModuleDetectionStrategy to the given base package.

Parameters:

rootPackage - must not be null.

strategy - must not be null.

fullyQualifiedModuleNames - whether to use fully qualified module names.

Returns:

will never be null.

from

static ApplicationModuleSource from(JavaPackage pkg,
 String identifier)

Creates a new ApplicationModuleSource for the given JavaPackage and name.

Parameters:

pkg - must not be null.

identifier - must not be null or empty.

Returns:

will never be null.

getModuleBasePackage

JavaPackage getModuleBasePackage()

Returns the base package for the module.

Returns:

will never be null.

getIdentifier

ApplicationModuleIdentifier getIdentifier()

Returns the ApplicationModuleIdentifier to be used for the module.

Returns:

will never be null.

getNamedInterfaces

NamedInterfaces getNamedInterfaces(ApplicationModuleInformation information)

Returns all NamedInterfaces for the given ApplicationModuleInformation.

Parameters:

information - must not be null.

Returns:

will never be null.

Since:

1.4

getNamedInterfaces

NamedInterfaces getNamedInterfaces(ApplicationModuleInformation information,
 JavaPackage basePackage)

Returns all NamedInterfaces for the given ApplicationModuleInformation and a customized JavaPackage.

Parameters:

information - must not be null.

Returns:

will never be null.

Since:

1.4.2

equals

public boolean equals(@Nullable 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