Package io.micronaut.module.info

Class AbstractMicronautModuleInfo

java.lang.Object

io.micronaut.module.info.AbstractMicronautModuleInfo

All Implemented Interfaces:

MicronautModuleInfo

public abstract class AbstractMicronautModuleInfo
extends Object
implements MicronautModuleInfo

Base class for Micronaut module information. It is recommended, though not required, to extend this class.

Constructor Summary

Constructors

Constructor	Description
AbstractMicronautModuleInfo(String id, String name, String description, String version, MavenCoordinates mavenCoordinates, String parentModuleId, Set<String> tags)

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDescription()	A description of this module.
String	getId()	The id for this module.
Optional<MavenCoordinates>	getMavenCoordinates()	Returns the Maven coordinates for this module, if it can be represented so.
String	getName()	A human readable name for this module.
Optional<String>	getParentModuleId()	A Micronaut module typically consists of a "main" module, for example Micronaut Data, and other modules, like "Micronaut Data JDBC".
Set<String>	getTags()	A set of tags assigned to this module.
String	getVersion()	The version of this module.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractMicronautModuleInfo

public AbstractMicronautModuleInfo(String id,
 String name,
 String description,
 String version,
 MavenCoordinates mavenCoordinates,
 String parentModuleId,
 Set<String> tags)

Method Details

getId

public String getId()

Description copied from interface: MicronautModuleInfo

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

Specified by:

getId in interface MicronautModuleInfo

Returns:

the id for this module.

getName

public String getName()

Description copied from interface: MicronautModuleInfo

A human readable name for this module.

Specified by:

getName in interface MicronautModuleInfo

Returns:

the name of this module

getDescription

public Optional<String> getDescription()

Description copied from interface: MicronautModuleInfo

A description of this module.

Specified by:

getDescription in interface MicronautModuleInfo

Returns:

the description

getVersion

public String getVersion()

Description copied from interface: MicronautModuleInfo

The version of this module.

Specified by:

getVersion in interface MicronautModuleInfo

Returns:

the version

getMavenCoordinates

public Optional<MavenCoordinates> getMavenCoordinates()

Description copied from interface: MicronautModuleInfo

Returns the Maven coordinates for this module, if it can be represented so.

Specified by:

getMavenCoordinates in interface MicronautModuleInfo

Returns:

the Maven coordinates

getParentModuleId

public Optional<String> getParentModuleId()

Description copied from interface: MicronautModuleInfo

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.

Specified by:

getParentModuleId in interface MicronautModuleInfo

Returns:

the parent module id, if any

getTags

public Set<String> getTags()

Description copied from interface: MicronautModuleInfo

A set of tags assigned to this module.

Specified by:

getTags in interface MicronautModuleInfo

Returns:

the set of tags for this module

toString

public String toString()

Overrides:

toString in class Object