Package org.springframework.modulith

Annotation Interface ApplicationModule

@Target({PACKAGE,ANNOTATION_TYPE}) @Retention(RUNTIME) public @interface ApplicationModule
Annotation to customize information of a Modulith module.
Author:
Oliver Drotbohm

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    allowedDependencies
    List the names of modules that the module is allowed to depend on.
    String
    displayName
    The human readable name of the module to be used for display and documentation purposes.

  • Element Details

    • displayName

      String displayName
      The human readable name of the module to be used for display and documentation purposes.
      Returns:
      will never be null.
      Default:
      ""

    • allowedDependencies

      String[] allowedDependencies
      List the names of modules that the module is allowed to depend on. Shared modules defined in Modulith will be allowed, too. Names listed are local ones, unless the application has configured Modulithic.useFullyQualifiedModuleNames() to true. Explicit references to NamedInterfaces need to be separated by a double colon ::, e.g. module::API if module is the logical module name and API is the name of the named interface.
      Returns:
      will never be null.
      See Also:
      Default:
      {}