Top Description Fields Constructors Methods
org.jboss.modules

public final Class LocalDependencySpecBuilder

extends DependencySpecBuilder
Class Inheritance
Imports
java.util.Collections, .Set, org.jboss.modules.filter.ClassFilter, .PathFilter, .PathFilters
A local dependency specification builder, which includes a module's own content or some other, external content.

Field Summary

Modifier and TypeField and Description
private Set<String>
loaderPaths

private LocalLoader
localLoader

Inherited from org.jboss.modules.DependencySpecBuilder:
classExportFilterclassImportFilterexportFilterimportFilterresourceExportFilterresourceImportFilter

Constructor Summary

AccessConstructor and Description
public
LocalDependencySpecBuilder()

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
public DependencySpec
build()

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

Construct the dependency specification.
public PathFilter

Returns:

the import filter to use
getImportFilter()

Overrides org.jboss.modules.DependencySpecBuilder.getImportFilter.

Get the import filter to use.
public Set<String>

Returns:

the loader paths set
getLoaderPaths()

Get the loader paths set.

public LocalLoader

Returns:

the local loader to use, or null to use the module's own content
getLocalLoader()

Get the local loader to use.

public LocalDependencySpecBuilder
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 LocalDependencySpecBuilder
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 LocalDependencySpecBuilder
setExport(final boolean
the export flag
export)

Overrides org.jboss.modules.DependencySpecBuilder.setExport.

Set a simple export filter, based on a boolean flag.
public LocalDependencySpecBuilder
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 LocalDependencySpecBuilder
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 LocalDependencySpecBuilder
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 LocalDependencySpecBuilder

Returns:

this builder
setLoaderPaths(final Set<String>
the loader paths set (must not be null)
loaderPaths)

Set the loader paths set.

public LocalDependencySpecBuilder

Returns:

this builder
setLocalLoader(final LocalLoader
the local loader to use, or null to use the module's own content
localLoader)

Set the local loader to use.

public LocalDependencySpecBuilder
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 LocalDependencySpecBuilder
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:
getClassExportFiltergetClassImportFiltergetExportFiltergetResourceExportFiltergetResourceImportFilter

Field Detail

loaderPathsback to summary
private Set<String> loaderPaths
localLoaderback to summary
private LocalLoader localLoader

Constructor Detail

LocalDependencySpecBuilderback to summary
public LocalDependencySpecBuilder()

Construct a new instance.

Method Detail

buildback to summary
public DependencySpec build()

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

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

Construct the dependency specification.

Returns:DependencySpec

the dependency specification

getImportFilterback to summary
public PathFilter getImportFilter()

Overrides org.jboss.modules.DependencySpecBuilder.getImportFilter.

Get the import filter to use. The default value is PathFilters#acceptAll().

Returns:PathFilter

the import filter to use

getLoaderPathsback to summary
public Set<String> getLoaderPaths()

Get the loader paths set. The default is the empty set. This value is ignored if the dependency specification refers to the module's own content.

Returns:Set<String>

the loader paths set

getLocalLoaderback to summary
public LocalLoader getLocalLoader()

Get the local loader to use. The default value is null, indicating that the content should come from the module being defined.

Returns:LocalLoader

the local loader to use, or null to use the module's own content

setClassExportFilterback to summary
public LocalDependencySpecBuilder 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:LocalDependencySpecBuilder

this builder

setClassImportFilterback to summary
public LocalDependencySpecBuilder 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:LocalDependencySpecBuilder

this builder

setExportback to summary
public LocalDependencySpecBuilder 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:LocalDependencySpecBuilder

this builder

setExportFilterback to summary
public LocalDependencySpecBuilder 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:LocalDependencySpecBuilder

this builder

setImportFilterback to summary
public LocalDependencySpecBuilder 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:LocalDependencySpecBuilder

this builder

setImportServicesback to summary
public LocalDependencySpecBuilder 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:LocalDependencySpecBuilder

this builder

setLoaderPathsback to summary
public LocalDependencySpecBuilder setLoaderPaths(final Set<String> loaderPaths)

Set the loader paths set.

Parameters
loaderPaths:Set<String>

the loader paths set (must not be null)

Returns:LocalDependencySpecBuilder

this builder

setLocalLoaderback to summary
public LocalDependencySpecBuilder setLocalLoader(final LocalLoader localLoader)

Set the local loader to use.

Parameters
localLoader:LocalLoader

the local loader to use, or null to use the module's own content

Returns:LocalDependencySpecBuilder

this builder

setResourceExportFilterback to summary
public LocalDependencySpecBuilder 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:LocalDependencySpecBuilder

this builder

setResourceImportFilterback to summary
public LocalDependencySpecBuilder 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:LocalDependencySpecBuilder

this builder