java.lang.Object
org.jboss.modules.DependencySpecBuilder
org.jboss.modules.ModuleDependencySpecBuilder
A builder for dependency specifications that refer to other modules.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Construct the dependency specification.Get the module loader of the dependency.getName()
Get the module name.boolean
Determine whether this dependency will be optional.setClassExportFilter
(ClassFilter classExportFilter) Set the class export filter to use.setClassImportFilter
(ClassFilter classImportFilter) Set the class import filter to use.setExport
(boolean export) Set a simple export filter, based on aboolean
flag.setExportFilter
(PathFilter exportFilter) Set the export filter to use.setImportFilter
(PathFilter importFilter) Set the import filter to use.setImportServices
(boolean services) Set a simple import filter, based on aboolean
flag specifying whether services should be imported.setModuleLoader
(ModuleLoader moduleLoader) Set the module loader of the dependency.Set the module name.setOptional
(boolean optional) Establish whether this dependency will be optional.setResourceExportFilter
(PathFilter resourceExportFilter) Set the resource export filter to use.setResourceImportFilter
(PathFilter resourceImportFilter) Set the resource import filter to use.Methods inherited from class org.jboss.modules.DependencySpecBuilder
getClassExportFilter, getClassImportFilter, getExportFilter, getImportFilter, getResourceExportFilter, getResourceImportFilter
-
Constructor Details
-
ModuleDependencySpecBuilder
public ModuleDependencySpecBuilder()Construct a new instance.
-
-
Method Details
-
setImportFilter
Description copied from class:DependencySpecBuilder
Set the import filter to use.- Overrides:
setImportFilter
in classDependencySpecBuilder
- Parameters:
importFilter
- the import filter to use (must not benull
)- Returns:
- this builder
-
setImportServices
Description copied from class:DependencySpecBuilder
Set a simple import filter, based on aboolean
flag specifying whether services should be imported. If the flag istrue
, the import filter is set toPathFilters.getDefaultImportFilterWithServices()
, otherwise it is set toPathFilters.getDefaultImportFilter()
. Any previous import filter setting is overwritten.- Overrides:
setImportServices
in classDependencySpecBuilder
- Parameters:
services
- the services flag- Returns:
- this builder
-
setExportFilter
Description copied from class:DependencySpecBuilder
Set the export filter to use.- Overrides:
setExportFilter
in classDependencySpecBuilder
- Parameters:
exportFilter
- the export filter to use (must not benull
)- Returns:
- this builder
-
setExport
Description copied from class:DependencySpecBuilder
Set a simple export filter, based on aboolean
flag. If the flag istrue
, the export filter is set toPathFilters.acceptAll()
, otherwise it is set toPathFilters.rejectAll()
. Any previous export filter setting is overwritten.- Overrides:
setExport
in classDependencySpecBuilder
- Parameters:
export
- the export flag- Returns:
- this builder
-
setResourceImportFilter
Description copied from class:DependencySpecBuilder
Set the resource import filter to use.- Overrides:
setResourceImportFilter
in classDependencySpecBuilder
- Parameters:
resourceImportFilter
- the resource import filter to use (must not benull
)- Returns:
- this builder
-
setResourceExportFilter
Description copied from class:DependencySpecBuilder
Set the resource export filter to use. The default value isPathFilters.acceptAll()
.- Overrides:
setResourceExportFilter
in classDependencySpecBuilder
- Parameters:
resourceExportFilter
- the resource export filter to use (must not benull
)- Returns:
- this builder
-
setClassImportFilter
Description copied from class:DependencySpecBuilder
Set the class import filter to use.- Overrides:
setClassImportFilter
in classDependencySpecBuilder
- Parameters:
classImportFilter
- the class import filter to use (must not benull
)- Returns:
- this builder
-
setClassExportFilter
Description copied from class:DependencySpecBuilder
Set the class export filter to use.- Overrides:
setClassExportFilter
in classDependencySpecBuilder
- Parameters:
classExportFilter
- the class export filter to use (must not benull
)- Returns:
- this builder
-
getModuleLoader
Get the module loader of the dependency. Defaults tonull
, indicating that the module loader to use should be the loader of the module being defined.- Returns:
- the module loader of the dependency, or
null
to use the module's own module loader
-
setModuleLoader
Set the module loader of the dependency.- Parameters:
moduleLoader
- the module loader of the dependency, ornull
to use the module's own module loader- Returns:
- this builder
-
getName
Get the module name.- Returns:
- the module name, or
null
if was not yet set
-
setName
Set the module name.- Parameters:
name
- the module name (must not benull
)- Returns:
- this builder
-
isOptional
public boolean isOptional()Determine whether this dependency will be optional. The default value isfalse
.- Returns:
true
if the dependency will be optional,false
if it will be required
-
setOptional
Establish whether this dependency will be optional.- Parameters:
optional
-true
if the dependency will be optional,false
if it will be required- Returns:
- this builder
-
build
Description copied from class:DependencySpecBuilder
Construct the dependency specification.- Specified by:
build
in classDependencySpecBuilder
- Returns:
- the dependency specification
-