Module java.base

Package java.lang.module

Class ModuleDescriptor.Builder

java.lang.Object

java.lang.module.ModuleDescriptor.Builder

Enclosing class:

ModuleDescriptor

public static final class ModuleDescriptor.Builder
extends Object

A builder used for building ModuleDescriptor objects.

ModuleDescriptor defines the module, openModule, and automaticModule methods to create builders for building different kinds of modules.

Example usage:

   ModuleDescriptor descriptor = ModuleDescriptor.module("m1")
         .exports("p")
         .requires("m2")
         .build();
 

API Note:

A Builder checks the components and invariants as components are added to the builder. The rational for this is to detect errors as early as possible and not defer all validation to the build method. A Builder cannot be used to create a synthetic module.

Since:

9

Method Summary

Modifier and Type	Method	Description
ModuleDescriptor	build()	Builds and returns a ModuleDescriptor from its components.
ModuleDescriptor.Builder	contains(String pn)	Adds a package to the module.
ModuleDescriptor.Builder	contains(Set<String> pns)	Adds a (possible empty) set of packages to the module
ModuleDescriptor.Builder	exports(ModuleDescriptor.Exports e)	Adds an export.
ModuleDescriptor.Builder	exports(String pn)	Adds an unqualified export.
ModuleDescriptor.Builder	exports(String pn, Set<String> targets)	Adds an export to export a package to a set of target modules.
ModuleDescriptor.Builder	exports(Set<ModuleDescriptor.Exports.Modifier> ms, String pn)	Adds an unqualified export with the given (and possibly empty) set of modifiers.
ModuleDescriptor.Builder	exports(Set<ModuleDescriptor.Exports.Modifier> ms, String pn, Set<String> targets)	Adds an export, with the given (and possibly empty) set of modifiers, to export a package to a set of target modules.
ModuleDescriptor.Builder	mainClass(String mc)	Sets the module main class.
ModuleDescriptor.Builder	opens(ModuleDescriptor.Opens obj)	Adds an opens directive.
ModuleDescriptor.Builder	opens(String pn)	Adds an opens directive to open a package.
ModuleDescriptor.Builder	opens(String pn, Set<String> targets)	Adds an opens directive to open a package to a set of target modules.
ModuleDescriptor.Builder	opens(Set<ModuleDescriptor.Opens.Modifier> ms, String pn)	Adds an opens directive to open a package with the given (and possibly empty) set of modifiers.
ModuleDescriptor.Builder	opens(Set<ModuleDescriptor.Opens.Modifier> ms, String pn, Set<String> targets)	Adds an opens directive, with the given (and possibly empty) set of modifiers, to open a package to a set of target modules.
ModuleDescriptor.Builder	osArch(String arch)	Sets the operating system architecture.
ModuleDescriptor.Builder	osName(String name)	Sets the operating system name.
ModuleDescriptor.Builder	osVersion(String version)	Sets the operating system version.
ModuleDescriptor.Builder	provides(ModuleDescriptor.Provides p)	Provides a service with one or more implementations.
ModuleDescriptor.Builder	provides(String service, String provider)	Provides an implementation of a service.
ModuleDescriptor.Builder	provides(String service, List<String> providers)	Provides implementations of a service.
ModuleDescriptor.Builder	requires(ModuleDescriptor.Requires req)	Adds a dependence on a module.
ModuleDescriptor.Builder	requires(String mn)	Adds a dependence on a module with an empty set of modifiers.
ModuleDescriptor.Builder	requires(Set<ModuleDescriptor.Requires.Modifier> ms, String mn)	Adds a dependence on a module with the given (and possibly empty) set of modifiers.
ModuleDescriptor.Builder	requires(Set<ModuleDescriptor.Requires.Modifier> ms, String mn, ModuleDescriptor.Version compiledVersion)	Adds a dependence on a module with the given (and possibly empty) set of modifiers.
ModuleDescriptor.Builder	uses(String service)	Adds a service dependence.
ModuleDescriptor.Builder	version(ModuleDescriptor.Version v)	Sets the module version.
ModuleDescriptor.Builder	version(String v)	Sets the module version.

Methods inherited from class java.lang.Object

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

Method Detail

requires

public ModuleDescriptor.Builder requires(ModuleDescriptor.Requires req)

Adds a dependence on a module.

Parameters:

req - The dependence

Returns:

This builder

Throws:

IllegalArgumentException - If the dependence is on the module that this builder was initialized to build

IllegalStateException - If the dependence on the module has already been declared

requires

public ModuleDescriptor.Builder requires(Set<ModuleDescriptor.Requires.Modifier> ms,
                                         String mn,
                                         ModuleDescriptor.Version compiledVersion)

Adds a dependence on a module with the given (and possibly empty) set of modifiers. The dependence includes the version of the module that that was recorded at compile-time.

Parameters:

ms - The set of modifiers

mn - The module name

compiledVersion - The version of the module recorded at compile-time

Returns:

This builder

Throws:

IllegalArgumentException - If the module name is null, is not a legal Java identifier, or is equal to the module name that this builder was initialized to build

IllegalStateException - If the dependence on the module has already been declared

requires

public ModuleDescriptor.Builder requires(Set<ModuleDescriptor.Requires.Modifier> ms,
                                         String mn)

Adds a dependence on a module with the given (and possibly empty) set of modifiers.

Parameters:

ms - The set of modifiers

mn - The module name

Returns:

This builder

Throws:

IllegalArgumentException - If the module name is null, is not a legal Java identifier, or is equal to the module name that this builder was initialized to build

IllegalStateException - If the dependence on the module has already been declared

requires

public ModuleDescriptor.Builder requires(String mn)

Adds a dependence on a module with an empty set of modifiers.

Parameters:

mn - The module name

Returns:

This builder

Throws:

IllegalArgumentException - If the module name is null, is not a legal Java identifier, or is equal to the module name that this builder was initialized to build

IllegalStateException - If the dependence on the module has already been declared

exports

public ModuleDescriptor.Builder exports(ModuleDescriptor.Exports e)

Adds an export.

Parameters:

e - The export

Returns:

This builder

Throws:

IllegalStateException - If the package is already declared as a package with the contains method or the package is already declared as exported

exports

public ModuleDescriptor.Builder exports(Set<ModuleDescriptor.Exports.Modifier> ms,
                                        String pn,
                                        Set<String> targets)

Adds an export, with the given (and possibly empty) set of modifiers, to export a package to a set of target modules.

Parameters:

ms - The set of modifiers

pn - The package name

targets - The set of target modules names

Returns:

This builder

Throws:

IllegalArgumentException - If the package name or any of the target modules is null or is not a legal Java identifier, or the set of targets is empty

IllegalStateException - If the package is already declared as a package with the contains method or the package is already declared as exported

exports

public ModuleDescriptor.Builder exports(Set<ModuleDescriptor.Exports.Modifier> ms,
                                        String pn)

Adds an unqualified export with the given (and possibly empty) set of modifiers.

Parameters:

ms - The set of modifiers

pn - The package name

Returns:

This builder

Throws:

IllegalArgumentException - If the package name is null or is not a legal Java identifier

IllegalStateException - If the package is already declared as a package with the contains method or the package is already declared as exported

exports

public ModuleDescriptor.Builder exports(String pn,
                                        Set<String> targets)

Adds an export to export a package to a set of target modules.

Parameters:

pn - The package name

targets - The set of target modules names

Returns:

This builder

Throws:

IllegalArgumentException - If the package name or any of the target modules is null or is not a legal Java identifier, or the set of targets is empty

IllegalStateException - If the package is already declared as a package with the contains method or the package is already declared as exported

exports

public ModuleDescriptor.Builder exports(String pn)

Adds an unqualified export.

Parameters:

pn - The package name

Returns:

This builder

Throws:

IllegalArgumentException - If the package name is null or is not a legal Java identifier

IllegalStateException - If the package is already declared as a package with the contains method or the package is already declared as exported

opens

public ModuleDescriptor.Builder opens(ModuleDescriptor.Opens obj)

Adds an opens directive.

Parameters:

obj - The Opens object

Returns:

This builder

Throws:

IllegalStateException - If the package is already declared as a package with the contains method, the package is already declared as open, or this is a builder for an open module

opens

public ModuleDescriptor.Builder opens(Set<ModuleDescriptor.Opens.Modifier> ms,
                                      String pn,
                                      Set<String> targets)

Adds an opens directive, with the given (and possibly empty) set of modifiers, to open a package to a set of target modules.

Parameters:

ms - The set of modifiers

pn - The package name

targets - The set of target modules names

Returns:

This builder

Throws:

IllegalArgumentException - If the package name or any of the target modules is null or is not a legal Java identifier, or the set of targets is empty

IllegalStateException - If the package is already declared as a package with the contains method, the package is already declared as open, or this is a builder for an open module

opens

public ModuleDescriptor.Builder opens(Set<ModuleDescriptor.Opens.Modifier> ms,
                                      String pn)

Adds an opens directive to open a package with the given (and possibly empty) set of modifiers.

Parameters:

ms - The set of modifiers

pn - The package name

Returns:

This builder

Throws:

IllegalArgumentException - If the package name is null or is not a legal Java identifier

IllegalStateException - If the package is already declared as a package with the contains method, the package is already declared as open, or this is a builder for an open module

opens

public ModuleDescriptor.Builder opens(String pn,
                                      Set<String> targets)

Adds an opens directive to open a package to a set of target modules.

Parameters:

pn - The package name

targets - The set of target modules names

Returns:

This builder

Throws:

IllegalArgumentException - If the package name or any of the target modules is null or is not a legal Java identifier, or the set of targets is empty

IllegalStateException - If the package is already declared as a package with the contains method, the package is already declared as open, or this is a builder for an open module

opens

public ModuleDescriptor.Builder opens(String pn)

Adds an opens directive to open a package.

Parameters:

pn - The package name

Returns:

This builder

Throws:

IllegalArgumentException - If the package name is null or is not a legal Java identifier

IllegalStateException - If the package is already declared as a package with the contains method, the package is already declared as open, or this is a builder for an open module

uses

public ModuleDescriptor.Builder uses(String service)

Adds a service dependence.

Parameters:

service - The service type

Returns:

This builder

Throws:

IllegalArgumentException - If the service type is null or is not a legal Java identifier

IllegalStateException - If a dependency on the service type has already been declared

provides

public ModuleDescriptor.Builder provides(ModuleDescriptor.Provides p)

Provides a service with one or more implementations.

Parameters:

p - The provides

Returns:

This builder

Throws:

IllegalStateException - If the providers for the service type have already been declared

provides

public ModuleDescriptor.Builder provides(String service,
                                         List<String> providers)

Provides implementations of a service.

Parameters:

service - The service type

providers - The list of provider or provider factory class names

Returns:

This builder

Throws:

IllegalArgumentException - If the service type or any of the provider class names is null or is not a legal Java identifier, or the list of provider class names is empty

IllegalStateException - If the providers for the service type have already been declared

provides

public ModuleDescriptor.Builder provides(String service,
                                         String provider)

Provides an implementation of a service.

Parameters:

service - The service type

provider - The provider or provider factory class name

Returns:

This builder

Throws:

IllegalArgumentException - If the service type or the provider class name is null or is not a legal Java identifier

IllegalStateException - If the providers for the service type have already been declared

contains

public ModuleDescriptor.Builder contains(Set<String> pns)

Adds a (possible empty) set of packages to the module

Parameters:

pns - The set of package names

Returns:

This builder

Throws:

IllegalArgumentException - If any of the package names is null or is not a legal Java identifier

IllegalStateException - If any of packages are already declared as packages in the module. This includes packages that are already declared as exported or open packages.

contains

public ModuleDescriptor.Builder contains(String pn)

Adds a package to the module.

Parameters:

pn - The package name

Returns:

This builder

Throws:

IllegalArgumentException - If the package name is null, or is not a legal Java identifier

IllegalStateException - If the package is already declared as a package in the module. This includes the package already declared as an exported or open package.

version

public ModuleDescriptor.Builder version(ModuleDescriptor.Version v)

Sets the module version.

Parameters:

v - The version

Returns:

This builder

version

public ModuleDescriptor.Builder version(String v)

Sets the module version.

Parameters:

v - The version string to parse

Returns:

This builder

Throws:

IllegalArgumentException - If v is null or cannot be parsed as a version string

See Also:

ModuleDescriptor.Version.parse(String)

mainClass

public ModuleDescriptor.Builder mainClass(String mc)

Sets the module main class.

Parameters:

mc - The module main class

Returns:

This builder

Throws:

IllegalArgumentException - If mainClass is null or is not a legal Java identifier

osName

public ModuleDescriptor.Builder osName(String name)

Sets the operating system name.

Parameters:

name - The operating system name

Returns:

This builder

Throws:

IllegalArgumentException - If name is null or the empty String

osArch

public ModuleDescriptor.Builder osArch(String arch)

Sets the operating system architecture.

Parameters:

arch - The operating system architecture

Returns:

This builder

Throws:

IllegalArgumentException - If name is null or the empty String

osVersion

public ModuleDescriptor.Builder osVersion(String version)

Sets the operating system version.

Parameters:

version - The operating system version

Returns:

This builder

Throws:

IllegalArgumentException - If name is null or the empty String

build

public ModuleDescriptor build()

Builds and returns a ModuleDescriptor from its components.

Returns:

The module descriptor