Package org.springframework.modulith.core

Class ApplicationModule.AllowedDependency

java.lang.Object

org.springframework.modulith.core.ApplicationModule.AllowedDependency

Enclosing class:

ApplicationModule

public static class ApplicationModule.AllowedDependency
extends Object

Describes a dependency explicitly declared as allowed for an ApplicationModule.

Since:

1.4.2, package private before

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
(package private) boolean	contains(com.tngtech.archunit.core.domain.JavaClass type)	Returns whether the ApplicationModule.AllowedDependency contains the given JavaClass.
(package private) boolean	contains(Class<?> type)	Returns whether the ApplicationModule.AllowedDependency contains the given Class.
boolean	equals(Object obj)
ApplicationModule	getTargetModule()	Returns the target module of the dependency.
NamedInterface	getTargetNamedInterface()	Returns the NamedInterface declared as valid target if declared.
int	hashCode()
(package private) static ApplicationModule.AllowedDependency	of(String identifier, ApplicationModule source, ApplicationModules modules)	Creates an ApplicationModule.AllowedDependency to the module and optionally named interface defined by the given identifier.
(package private) static ApplicationModule.AllowedDependency	to(ApplicationModule module)	Creates a new ApplicationModule.AllowedDependency to the unnamed interface of the given ApplicationModule.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

of

static ApplicationModule.AllowedDependency of(String identifier,
 ApplicationModule source,
 ApplicationModules modules)

Creates an ApplicationModule.AllowedDependency to the module and optionally named interface defined by the given identifier.

Parameters:

identifier - must not be null or empty. Follows the ${moduleName}(::${namedInterfaceName}) pattern.

source - the source module of the dependency, must not be null.

modules - must not be null.

Returns:

will never be null.

Throws:

IllegalArgumentException - in case the given identifier is invalid, i.e. does not refer to an existing module or named interface.

to

static ApplicationModule.AllowedDependency to(ApplicationModule module)

Creates a new ApplicationModule.AllowedDependency to the unnamed interface of the given ApplicationModule.

Parameters:

module - must not be null.

Returns:

getTargetModule

public ApplicationModule getTargetModule()

Returns the target module of the dependency.

Returns:

will never be null.

getTargetNamedInterface

@Nullable
public NamedInterface getTargetNamedInterface()

Returns the NamedInterface declared as valid target if declared.

Returns:

can be null.

contains

boolean contains(com.tngtech.archunit.core.domain.JavaClass type)

Returns whether the ApplicationModule.AllowedDependency contains the given JavaClass.

Parameters:

type - must not be null.

Returns:

contains

boolean contains(Class<?> type)

Returns whether the ApplicationModule.AllowedDependency contains the given Class.

Parameters:

type - must not be null.

Returns:

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
 Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object