Module io.inverno.tool.buildtools

Package io.inverno.tool.buildtools

Class ModuleInfo

java.lang.Object

io.inverno.tool.buildtools.ModuleInfo

public class ModuleInfo
extends Object

Describes a module-info descriptor as specified in the Java language specification.

Multiple ModuleInfo instances can be specified on the ModularizeDependenciesTask to override or extend module-info.java descriptors generated when modularizing project's dependencies.

Since:

1.4

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModuleInfo.ExportsDirective	Represents an exports directive in a module descriptor.
static class	ModuleInfo.ImportDeclaration	Represents an import declaration in a module descriptor.
static class	ModuleInfo.OpensDirective	Represents an opens directive in a module descriptor.
static class	ModuleInfo.ProvidesDirective	Represents a provides directive in a module descriptor.
static class	ModuleInfo.RequiresDirective	Represents a requires directive in a module descriptor.
static class	ModuleInfo.UsesDirective	Represents a uses directive in a module descriptor.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ModuleInfo.ExportsDirective>	exports	Module's exports directives.
protected List<ModuleInfo.ImportDeclaration>	imports	Module's import declarations.
protected String	name	The module name
protected boolean	open	Flag indicating whether the module should be declared as opened.
protected List<ModuleInfo.OpensDirective>	opens	Module's opens directives.
protected List<ModuleInfo.ProvidesDirective>	provides	Module's provides directives.
protected List<ModuleInfo.RequiresDirective>	requires	Module's requires directives.
protected List<ModuleInfo.UsesDirective>	uses	Module's uses directives.

Constructor Summary

Constructors

Constructor	Description
ModuleInfo()	Creates a blank module info.
ModuleInfo(String name, boolean open, List<ModuleInfo.ImportDeclaration> imports, List<ModuleInfo.RequiresDirective> requires, List<ModuleInfo.ExportsDirective> exports, List<ModuleInfo.OpensDirective> opens, List<ModuleInfo.UsesDirective> uses, List<ModuleInfo.ProvidesDirective> provides)	Creates a module info.

Method Summary

Modifier and Type	Method	Description
List<ModuleInfo.ExportsDirective>	getExports()	Returns module's exports directives.
List<ModuleInfo.ImportDeclaration>	getImports()	Returns module's import declarations.
String	getName()	Returns the name of the module.
List<ModuleInfo.OpensDirective>	getOpens()	Returns module's opens directives.
List<ModuleInfo.ProvidesDirective>	getProvides()	Returns module's provides directives.
List<ModuleInfo.RequiresDirective>	getRequires()	Returns module's requires directives.
List<ModuleInfo.UsesDirective>	getUses()	Returns module's uses directives.
boolean	isOpen()	Determines whether the module is opened.
void	setOpen(boolean open)	Sets whether the module is opened.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

The module name

open

protected boolean open

Flag indicating whether the module should be declared as opened.

imports

protected List<ModuleInfo.ImportDeclaration> imports

Module's import declarations.

requires

protected List<ModuleInfo.RequiresDirective> requires

Module's requires directives.

exports

protected List<ModuleInfo.ExportsDirective> exports

Module's exports directives.

opens

protected List<ModuleInfo.OpensDirective> opens

Module's opens directives.

uses

protected List<ModuleInfo.UsesDirective> uses

Module's uses directives.

provides

protected List<ModuleInfo.ProvidesDirective> provides

Module's provides directives.

Constructor Details

ModuleInfo

public ModuleInfo()

Creates a blank module info.

ModuleInfo

public ModuleInfo(String name,
 boolean open,
 List<ModuleInfo.ImportDeclaration> imports,
 List<ModuleInfo.RequiresDirective> requires,
 List<ModuleInfo.ExportsDirective> exports,
 List<ModuleInfo.OpensDirective> opens,
 List<ModuleInfo.UsesDirective> uses,
 List<ModuleInfo.ProvidesDirective> provides)

Creates a module info.

Parameters:

name - the module's name

open - true to open the module, false otherwise

imports - the list of import declarations

requires - the list of requires directives

exports - the list of exports directives

opens - the list of opens directives

uses - the list of uses directives

provides - the list of provides directives

Method Details

getName

public String getName()

Returns the name of the module.

Returns:

the module's name

isOpen

public boolean isOpen()

Determines whether the module is opened.

Returns:

true if the module is opened, false otherwise

setOpen

public void setOpen(boolean open)

Sets whether the module is opened.

Parameters:

open - true to open the module, false otherwise

getImports

public List<ModuleInfo.ImportDeclaration> getImports()

Returns module's import declarations.

Returns:

the mutable list of import declarations

getRequires

public List<ModuleInfo.RequiresDirective> getRequires()

Returns module's requires directives.

Returns:

the mutable list of requires directives

getExports

public List<ModuleInfo.ExportsDirective> getExports()

Returns module's exports directives.

Returns:

the mutable list of exports directives

getOpens

public List<ModuleInfo.OpensDirective> getOpens()

Returns module's opens directives.

Returns:

the mutable list of opens directives

getUses

public List<ModuleInfo.UsesDirective> getUses()

Returns module's uses directives.

Returns:

the mutable list of uses directives

getProvides

public List<ModuleInfo.ProvidesDirective> getProvides()

Returns module's provides directives.

Returns:

the mutable list of provides directives

toString

public String toString()

Overrides:

toString in class Object