Package org.springframework.modulith.core

Class ApplicationModuleDependencies

java.lang.Object

org.springframework.modulith.core.ApplicationModuleDependencies

public class ApplicationModuleDependencies
extends Object

The materialized, in other words actually present, dependencies of the current module towards other modules.

Author:

Oliver Drotbohm

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final ApplicationModuleDependencies	NONE

Method Summary

Modifier and Type	Method	Description
boolean	contains(String type)	Returns whether the dependencies contain the type with the given fully-qualified name.
boolean	contains(ApplicationModule module)	Returns whether the dependencies contain the given ApplicationModule.
boolean	containsModuleNamed(String name)	Returns whether the dependencies contain the ApplicationModule with the given name.
@Nullable ApplicationModule	getModuleByType(String name)	Returns the ApplicationModule containing the given type.
boolean	isEmpty()	Returns whether there are any dependencies at all.
(package private) static ApplicationModuleDependencies	of(List<ApplicationModuleDependency> dependencies)	Creates a new ApplicationModuleDependencies for the given List of ApplicationModuleDependency.
Stream<ApplicationModuleDependency>	stream()	Returns all ApplicationModuleDependency instances as Stream.
Stream<ApplicationModule>	uniqueModules()	Returns all unique ApplicationModules involved in the dependencies.
Stream<ApplicationModuleDependency>	uniqueStream(Function<ApplicationModuleDependency,Object> extractor)	Return all ApplicationModuleDependency instances unique by the value extracted using the given Function.
ApplicationModuleDependencies	withType(DependencyType type)	Returns a new ApplicationModuleDependencies instance containing only the dependencies of the given DependencyType.

Methods inherited from class java.lang.Object

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

Field Details

NONE

static final ApplicationModuleDependencies NONE

Method Details

of

static ApplicationModuleDependencies of(List<ApplicationModuleDependency> dependencies)

Creates a new ApplicationModuleDependencies for the given List of ApplicationModuleDependency.

Parameters:

dependencies - must not be null.

Returns:

will never be null.

contains

public boolean contains(ApplicationModule module)

Returns whether the dependencies contain the given ApplicationModule.

Parameters:

module - must not be null.

Returns:

will never be null.

containsModuleNamed

public boolean containsModuleNamed(String name)

Returns whether the dependencies contain the ApplicationModule with the given name.

Parameters:

name - must not be null or empty.

Returns:

will never be null.

stream

public Stream<ApplicationModuleDependency> stream()

Returns all ApplicationModuleDependency instances as Stream.

Returns:

will never be null.

uniqueStream

public Stream<ApplicationModuleDependency> uniqueStream(Function<ApplicationModuleDependency,Object> extractor)

Return all ApplicationModuleDependency instances unique by the value extracted using the given Function.

Parameters:

extractor - will never be null.

Returns:

will never be null.

withType

public ApplicationModuleDependencies withType(DependencyType type)

Returns a new ApplicationModuleDependencies instance containing only the dependencies of the given DependencyType.

Parameters:

type - must not be null.

Returns:

isEmpty

public boolean isEmpty()

Returns whether there are any dependencies at all.

Returns:

will never be null.

contains

public boolean contains(String type)

Returns whether the dependencies contain the type with the given fully-qualified name.

Parameters:

type - must not be null or empty.

Returns:

Since:

1.3

uniqueModules

public Stream<ApplicationModule> uniqueModules()

Returns all unique ApplicationModules involved in the dependencies.

Returns:

will never be null.

getModuleByType

public @Nullable ApplicationModule getModuleByType(String name)

Returns the ApplicationModule containing the given type.

Parameters:

name - must not be null or empty.

Returns:

will never be null.