JBoss Modules 2.1.3.Final · org.jboss.modules.ModuleDependencySpecBuilder

Modifier and Type	Field and Description
pack-priv ModuleLoader	moduleLoader
pack-priv String	name
pack-priv boolean	optional

Access	Constructor and Description
public	ModuleDependencySpecBuilder() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
public ModuleDependencySpec	build() Implements abstract org.jboss.modules.DependencySpecBuilder.build. Construct the dependency specification.
public ModuleLoader	Returns: the module loader of the dependency, or `null` to use the module's own module loader getModuleLoader() Get the module loader of the dependency.
public String	Returns: the module name, or `null` if was not yet set getName() Get the module name.
public boolean	Returns: `true` if the dependency will be optional, `false` if it will be required isOptional() Determine whether this dependency will be optional.
public ModuleDependencySpecBuilder	setClassExportFilter(final ClassFilter the class export filter to use (must not be `null`) classExportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setClassExportFilter. Set the class export filter to use.
public ModuleDependencySpecBuilder	setClassImportFilter(final ClassFilter the class import filter to use (must not be `null`) classImportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setClassImportFilter. Set the class import filter to use.
public ModuleDependencySpecBuilder	setExport(final boolean the export flag export) Overrides org.jboss.modules.DependencySpecBuilder.setExport. Set a simple export filter, based on a `boolean` flag.
public ModuleDependencySpecBuilder	setExportFilter(final PathFilter the export filter to use (must not be `null`) exportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setExportFilter. Set the export filter to use.
public ModuleDependencySpecBuilder	setImportFilter(final PathFilter the import filter to use (must not be `null`) importFilter) Overrides org.jboss.modules.DependencySpecBuilder.setImportFilter. Set the import filter to use.
public ModuleDependencySpecBuilder	setImportServices(final boolean the services flag services) Overrides org.jboss.modules.DependencySpecBuilder.setImportServices. Set a simple import filter, based on a `boolean` flag specifying whether services should be imported.
public ModuleDependencySpecBuilder	Returns: this builder setModuleLoader(final ModuleLoader the module loader of the dependency, or `null` to use the module's own module loader moduleLoader) Set the module loader of the dependency.
public ModuleDependencySpecBuilder	Returns: this builder setName(final String the module name (must not be `null`) name) Set the module name.
public ModuleDependencySpecBuilder	Returns: this builder setOptional(final boolean `true` if the dependency will be optional, `false` if it will be required optional) Establish whether this dependency will be optional.
public ModuleDependencySpecBuilder	setResourceExportFilter(final PathFilter the resource export filter to use (must not be `null`) resourceExportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setResourceExportFilter. Set the resource export filter to use.
public ModuleDependencySpecBuilder	setResourceImportFilter(final PathFilter the resource import filter to use (must not be `null`) resourceImportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setResourceImportFilter. Set the resource import filter to use.

Inherited from org.jboss.modules.DependencySpecBuilder:: getClassExportFilter getClassImportFilter getExportFilter getImportFilter getResourceExportFilter getResourceImportFilter

moduleLoader	back to summary
pack-priv ModuleLoader moduleLoader

name	back to summary
pack-priv String name

optional	back to summary
pack-priv boolean optional

ModuleDependencySpecBuilder	back to summary
public ModuleDependencySpecBuilder() Construct a new instance.

Method Detail

build	back to summary
public ModuleDependencySpec build() Implements abstract org.jboss.modules.DependencySpecBuilder.build. Doc from org.jboss.modules.DependencySpecBuilder.build. Construct the dependency specification. Returns:ModuleDependencySpec the dependency specification

build

back to summary

public ModuleDependencySpec build()

Implements abstract org.jboss.modules.DependencySpecBuilder.build.

Doc from org.jboss.modules.DependencySpecBuilder.build.

Construct the dependency specification.

Returns:ModuleDependencySpec: the dependency specification

getModuleLoader back to summary

getModuleLoader	back to summary
public ModuleLoader getModuleLoader() Get the module loader of the dependency. Defaults to `null`, indicating that the module loader to use should be the loader of the module being defined. Returns:ModuleLoader the module loader of the dependency, or `null` to use the module's own module loader

public ModuleLoader getModuleLoader()

Get the module loader of the dependency. Defaults to null, indicating that the module loader to use should be the loader of the module being defined.

Returns:ModuleLoader: the module loader of the dependency, or null to use the module's own module loader

getName back to summary

getName	back to summary
public String getName() Get the module name. Returns:String the module name, or `null` if was not yet set

public String getName()

Get the module name.

Returns:String: the module name, or null if was not yet set

isOptional back to summary

isOptional	back to summary
public boolean isOptional() Determine whether this dependency will be optional. The default value is `false`. Returns:boolean `true` if the dependency will be optional, `false` if it will be required

public boolean isOptional()

Determine whether this dependency will be optional. The default value is false.

Returns:boolean: true if the dependency will be optional, false if it will be required

setClassExportFilter back to summary

setClassExportFilter	back to summary
public ModuleDependencySpecBuilder setClassExportFilter(final ClassFilter classExportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setClassExportFilter. Doc from org.jboss.modules.DependencySpecBuilder.setClassExportFilter. Set the class export filter to use. Parameters classExportFilter:ClassFilter the class export filter to use (must not be `null`) Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setClassExportFilter(final ClassFilter classExportFilter)

Overrides org.jboss.modules.DependencySpecBuilder.setClassExportFilter.

Doc from org.jboss.modules.DependencySpecBuilder.setClassExportFilter.

Set the class export filter to use.

Parameters

classExportFilter:ClassFilter: the class export filter to use (must not be null)

Returns:ModuleDependencySpecBuilder

this builder

setClassImportFilter back to summary

setClassImportFilter	back to summary
public ModuleDependencySpecBuilder setClassImportFilter(final ClassFilter classImportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setClassImportFilter. Doc from org.jboss.modules.DependencySpecBuilder.setClassImportFilter. Set the class import filter to use. Parameters classImportFilter:ClassFilter the class import filter to use (must not be `null`) Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setClassImportFilter(final ClassFilter classImportFilter)

Overrides org.jboss.modules.DependencySpecBuilder.setClassImportFilter.

Doc from org.jboss.modules.DependencySpecBuilder.setClassImportFilter.

Set the class import filter to use.

Parameters

classImportFilter:ClassFilter: the class import filter to use (must not be null)

Returns:ModuleDependencySpecBuilder

this builder

setExport back to summary

setExport	back to summary
public ModuleDependencySpecBuilder setExport(final boolean export) Overrides org.jboss.modules.DependencySpecBuilder.setExport. Doc from org.jboss.modules.DependencySpecBuilder.setExport. Set a simple export filter, based on a `boolean` flag. If the flag is `true`, the export filter is set to `PathFilters#acceptAll()`, otherwise it is set to `PathFilters#rejectAll()`. Any previous export filter setting is overwritten. Parameters export:boolean the export flag Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setExport(final boolean export)

Overrides org.jboss.modules.DependencySpecBuilder.setExport.

Doc from org.jboss.modules.DependencySpecBuilder.setExport.

Set a simple export filter, based on a boolean flag. If the flag is true, the export filter is set to PathFilters#acceptAll(), otherwise it is set to PathFilters#rejectAll(). Any previous export filter setting is overwritten.

Parameters

export:boolean: the export flag

Returns:ModuleDependencySpecBuilder

this builder

setExportFilter back to summary

setExportFilter	back to summary
public ModuleDependencySpecBuilder setExportFilter(final PathFilter exportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setExportFilter. Doc from org.jboss.modules.DependencySpecBuilder.setExportFilter. Set the export filter to use. Parameters exportFilter:PathFilter the export filter to use (must not be `null`) Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setExportFilter(final PathFilter exportFilter)

Overrides org.jboss.modules.DependencySpecBuilder.setExportFilter.

Doc from org.jboss.modules.DependencySpecBuilder.setExportFilter.

Set the export filter to use.

Parameters

exportFilter:PathFilter: the export filter to use (must not be null)

Returns:ModuleDependencySpecBuilder

this builder

setImportFilter back to summary

setImportFilter	back to summary
public ModuleDependencySpecBuilder setImportFilter(final PathFilter importFilter) Overrides org.jboss.modules.DependencySpecBuilder.setImportFilter. Doc from org.jboss.modules.DependencySpecBuilder.setImportFilter. Set the import filter to use. Parameters importFilter:PathFilter the import filter to use (must not be `null`) Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setImportFilter(final PathFilter importFilter)

Overrides org.jboss.modules.DependencySpecBuilder.setImportFilter.

Doc from org.jboss.modules.DependencySpecBuilder.setImportFilter.

Set the import filter to use.

Parameters

importFilter:PathFilter: the import filter to use (must not be null)

Returns:ModuleDependencySpecBuilder

this builder

setImportServices back to summary

setImportServices	back to summary
public ModuleDependencySpecBuilder setImportServices(final boolean services) Overrides org.jboss.modules.DependencySpecBuilder.setImportServices. Doc from org.jboss.modules.DependencySpecBuilder.setImportServices. Set a simple import filter, based on a `boolean` flag specifying whether services should be imported. If the flag is `true`, the import filter is set to `PathFilters#getDefaultImportFilterWithServices()`, otherwise it is set to `PathFilters#getDefaultImportFilter()`. Any previous import filter setting is overwritten. Parameters services:boolean the services flag Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setImportServices(final boolean services)

Overrides org.jboss.modules.DependencySpecBuilder.setImportServices.

Doc from org.jboss.modules.DependencySpecBuilder.setImportServices.

Set a simple import filter, based on a boolean flag specifying whether services should be imported. If the flag is true, the import filter is set to PathFilters#getDefaultImportFilterWithServices(), otherwise it is set to PathFilters#getDefaultImportFilter(). Any previous import filter setting is overwritten.

Parameters

services:boolean: the services flag

Returns:ModuleDependencySpecBuilder

this builder

setModuleLoader back to summary

setModuleLoader	back to summary
public ModuleDependencySpecBuilder setModuleLoader(final ModuleLoader moduleLoader) Set the module loader of the dependency. Parameters moduleLoader:ModuleLoader the module loader of the dependency, or `null` to use the module's own module loader Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setModuleLoader(final ModuleLoader moduleLoader)

Set the module loader of the dependency.

Parameters

moduleLoader:ModuleLoader: the module loader of the dependency, or null to use the module's own module loader

Returns:ModuleDependencySpecBuilder

this builder

setName back to summary

setName	back to summary
public ModuleDependencySpecBuilder setName(final String name) Set the module name. Parameters name:String the module name (must not be `null`) Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setName(final String name)

Set the module name.

Parameters

name:String: the module name (must not be null)

Returns:ModuleDependencySpecBuilder

this builder

setOptional back to summary

setOptional	back to summary
public ModuleDependencySpecBuilder setOptional(final boolean optional) Establish whether this dependency will be optional. Parameters optional:boolean `true` if the dependency will be optional, `false` if it will be required Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setOptional(final boolean optional)

Establish whether this dependency will be optional.

Parameters

optional:boolean: true if the dependency will be optional, false if it will be required

Returns:ModuleDependencySpecBuilder

this builder

setResourceExportFilter back to summary

setResourceExportFilter	back to summary
public ModuleDependencySpecBuilder setResourceExportFilter(final PathFilter resourceExportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setResourceExportFilter. Doc from org.jboss.modules.DependencySpecBuilder.setResourceExportFilter. Set the resource export filter to use. The default value is `PathFilters#acceptAll()`. Parameters resourceExportFilter:PathFilter the resource export filter to use (must not be `null`) Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setResourceExportFilter(final PathFilter resourceExportFilter)

Overrides org.jboss.modules.DependencySpecBuilder.setResourceExportFilter.

Doc from org.jboss.modules.DependencySpecBuilder.setResourceExportFilter.

Set the resource export filter to use. The default value is PathFilters#acceptAll().

Parameters

resourceExportFilter:PathFilter: the resource export filter to use (must not be null)

Returns:ModuleDependencySpecBuilder

this builder

setResourceImportFilter back to summary

setResourceImportFilter	back to summary
public ModuleDependencySpecBuilder setResourceImportFilter(final PathFilter resourceImportFilter) Overrides org.jboss.modules.DependencySpecBuilder.setResourceImportFilter. Doc from org.jboss.modules.DependencySpecBuilder.setResourceImportFilter. Set the resource import filter to use. Parameters resourceImportFilter:PathFilter the resource import filter to use (must not be `null`) Returns:ModuleDependencySpecBuilder this builder

public ModuleDependencySpecBuilder setResourceImportFilter(final PathFilter resourceImportFilter)

Overrides org.jboss.modules.DependencySpecBuilder.setResourceImportFilter.

Doc from org.jboss.modules.DependencySpecBuilder.setResourceImportFilter.

Set the resource import filter to use.

Parameters

resourceImportFilter:PathFilter: the resource import filter to use (must not be null)

Returns:ModuleDependencySpecBuilder

this builder

public final Class ModuleDependencySpecBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail