Package io.micronaut.module.info

Interface MicronautModuleInfo

All Known Implementing Classes:
AbstractMicronautModuleInfo
public interface MicronautModuleInfo
Represents information about Micronaut modules which are available at runtime. This can be used for diagnostics. Information is loaded via service loading. Each module is recommended to extend the abstract class instead of directly implementing this interface.

  • Method Details

    • getId

      String getId()
      The id for this module. It is recommended to use groupId:artifactId Do NOT include version information in the id.
      Returns:
      the id for this module.

    • getName

      String getName()
      A human readable name for this module.
      Returns:
      the name of this module

    • getDescription

      Optional<String> getDescription()
      A description of this module.
      Returns:
      the description

    • getVersion

      String getVersion()
      The version of this module.
      Returns:
      the version

    • getMavenCoordinates

      Optional<MavenCoordinates> getMavenCoordinates()
      Returns the Maven coordinates for this module, if it can be represented so.
      Returns:
      the Maven coordinates

    • getParentModuleId

      Optional<String> getParentModuleId()
      A Micronaut module typically consists of a "main" module, for example Micronaut Data, and other modules, like "Micronaut Data JDBC". If this module is secondary module that should be grouped together with a main module, this method should return the main module id.
      Returns:
      the parent module id, if any

    • getTags

      Set<String> getTags()
      A set of tags assigned to this module.
      Returns:
      the set of tags for this module