Package io.micronaut.module.info
Class AbstractMicronautModuleInfo
java.lang.Object
io.micronaut.module.info.AbstractMicronautModuleInfo
- All Implemented Interfaces:
MicronautModuleInfo
Base class for Micronaut module information.
It is recommended, though not required, to extend this class.
-
Constructor Summary
ConstructorsConstructorDescriptionAbstractMicronautModuleInfo(String id, String name, String description, String version, MavenCoordinates mavenCoordinates, String parentModuleId, Set<String> tags) -
Method Summary
Modifier and TypeMethodDescriptionA description of this module.getId()The id for this module.Returns the Maven coordinates for this module, if it can be represented so.getName()A human readable name for this module.A Micronaut module typically consists of a "main" module, for example Micronaut Data, and other modules, like "Micronaut Data JDBC".getTags()A set of tags assigned to this module.The version of this module.toString()
-
Constructor Details
-
AbstractMicronautModuleInfo
-
-
Method Details
-
getId
Description copied from interface:MicronautModuleInfoThe id for this module. It is recommended to use groupId:artifactId Do NOT include version information in the id.- Specified by:
getIdin interfaceMicronautModuleInfo- Returns:
- the id for this module.
-
getName
Description copied from interface:MicronautModuleInfoA human readable name for this module.- Specified by:
getNamein interfaceMicronautModuleInfo- Returns:
- the name of this module
-
getDescription
Description copied from interface:MicronautModuleInfoA description of this module.- Specified by:
getDescriptionin interfaceMicronautModuleInfo- Returns:
- the description
-
getVersion
Description copied from interface:MicronautModuleInfoThe version of this module.- Specified by:
getVersionin interfaceMicronautModuleInfo- Returns:
- the version
-
getMavenCoordinates
Description copied from interface:MicronautModuleInfoReturns the Maven coordinates for this module, if it can be represented so.- Specified by:
getMavenCoordinatesin interfaceMicronautModuleInfo- Returns:
- the Maven coordinates
-
getParentModuleId
Description copied from interface:MicronautModuleInfoA 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.- Specified by:
getParentModuleIdin interfaceMicronautModuleInfo- Returns:
- the parent module id, if any
-
getTags
Description copied from interface:MicronautModuleInfoA set of tags assigned to this module.- Specified by:
getTagsin interfaceMicronautModuleInfo- Returns:
- the set of tags for this module
-
toString
-