Package io.micronaut.module.info.runtime

Class MicronautRuntimeModule

java.lang.Object

io.micronaut.module.info.runtime.MicronautRuntimeModule

@NonNull
public final class MicronautRuntimeModule
extends Object

Represents a resolved Micronaut module at runtime with parent and children references. Instead of IDs, this runtime bean uses references to model the hierarchy and replaces MicronautModuleInfo which uses IDs for hierarchical relationships.

Constructor Summary

Constructors

Constructor	Description
MicronautRuntimeModule(MicronautModuleInfo info, MicronautRuntimeModule parent, List<MicronautRuntimeModule> children)

Method Summary

Modifier and Type	Method	Description
List<MicronautRuntimeModule>	getChildren()	Returns the child modules.
Optional<String>	getDescription()	A description of this module.
String	getId()	The id for this module.
MicronautModuleInfo	getInfo()
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<MicronautRuntimeModule>	getParent()	Returns the parent module, if any.
MicronautRuntimeModule	getRoot()	Returns the root module descriptor.
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

MicronautRuntimeModule

public MicronautRuntimeModule(MicronautModuleInfo info,
 MicronautRuntimeModule parent,
 List<MicronautRuntimeModule> children)

Method Details

getInfo

public MicronautModuleInfo getInfo()

getId

public 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

public String getName()

A human-readable name for this module.

Returns:

the name of this module

getDescription

public Optional<String> getDescription()

A description of this module.

Returns:

the description

getVersion

public String getVersion()

The version of this module.

Returns:

the version

getMavenCoordinates

public Optional<MavenCoordinates> getMavenCoordinates()

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

Returns:

the Maven coordinates

getParent

public Optional<MicronautRuntimeModule> getParent()

Returns the parent module, if any.

Returns:

the parent module

getChildren

public List<MicronautRuntimeModule> getChildren()

Returns the child modules.

Returns:

the child modules

getTags

public Set<String> getTags()

A set of tags assigned to this module.

Returns:

the set of tags for this module

getRoot

public MicronautRuntimeModule getRoot()

Returns the root module descriptor.

Returns:

the root descriptor

toString

public String toString()

Overrides:

toString in class Object