Top Description Fields Constructors Methods
org.jboss.modules

public abstract Class DependencySpecBuilder

extends Object
Class Inheritance
Known Direct Subclasses
org.jboss.modules.ModuleDependencySpecBuilder, org.jboss.modules.LocalDependencySpecBuilder
Imports
org.jboss.modules.filter.ClassFilter, .ClassFilters, .PathFilter, .PathFilters
The base class of dependency specification builders.

Field Summary

Modifier and TypeField and Description
pack-priv ClassFilter
classExportFilter

pack-priv ClassFilter
classImportFilter

pack-priv PathFilter
exportFilter

pack-priv PathFilter
importFilter

pack-priv PathFilter
resourceExportFilter

pack-priv PathFilter
resourceImportFilter

Constructor Summary

AccessConstructor and Description
public
DependencySpecBuilder()

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
public abstract DependencySpec

Returns:

the dependency specification
build()

Construct the dependency specification.

public ClassFilter

Returns:

the class export filter to use
getClassExportFilter()

Get the class export filter to use.

public ClassFilter

Returns:

the class import filter to use
getClassImportFilter()

Get the class import filter to use.

public PathFilter

Returns:

the export filter to use
getExportFilter()

Get the export filter to use.

public PathFilter

Returns:

the import filter to use
getImportFilter()

Get the import filter to use.

public PathFilter

Returns:

the resource export filter to use
getResourceExportFilter()

Get the resource export filter to use.

public PathFilter

Returns:

the resource import filter to use
getResourceImportFilter()

Get the resource import filter to use.

public DependencySpecBuilder

Returns:

this builder
setClassExportFilter(final ClassFilter
the class export filter to use (must not be null)
classExportFilter)

Set the class export filter to use.

public DependencySpecBuilder

Returns:

this builder
setClassImportFilter(final ClassFilter
the class import filter to use (must not be null)
classImportFilter)

Set the class import filter to use.

public DependencySpecBuilder

Returns:

this builder
setExport(final boolean
the export flag
export)

Set a simple export filter, based on a boolean flag.

public DependencySpecBuilder

Returns:

this builder
setExportFilter(final PathFilter
the export filter to use (must not be null)
exportFilter)

Set the export filter to use.

public DependencySpecBuilder

Returns:

this builder
setImportFilter(final PathFilter
the import filter to use (must not be null)
importFilter)

Set the import filter to use.

public DependencySpecBuilder

Returns:

this builder
setImportServices(final boolean
the services flag
services)

Set a simple import filter, based on a boolean flag specifying whether services should be imported.

public DependencySpecBuilder

Returns:

this builder
setResourceExportFilter(final PathFilter
the resource export filter to use (must not be null)
resourceExportFilter)

Set the resource export filter to use.

public DependencySpecBuilder

Returns:

this builder
setResourceImportFilter(final PathFilter
the resource import filter to use (must not be null)
resourceImportFilter)

Set the resource import filter to use.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

classExportFilterback to summary
pack-priv ClassFilter classExportFilter
classImportFilterback to summary
pack-priv ClassFilter classImportFilter
exportFilterback to summary
pack-priv PathFilter exportFilter
importFilterback to summary
pack-priv PathFilter importFilter
resourceExportFilterback to summary
pack-priv PathFilter resourceExportFilter
resourceImportFilterback to summary
pack-priv PathFilter resourceImportFilter

Constructor Detail

DependencySpecBuilderback to summary
public DependencySpecBuilder()

Construct a new instance.

Method Detail

buildback to summary
public abstract DependencySpec build()

Construct the dependency specification.

Returns:DependencySpec

the dependency specification

getClassExportFilterback to summary
public ClassFilter getClassExportFilter()

Get the class export filter to use. The default value is ClassFilters#acceptAll().

Returns:ClassFilter

the class export filter to use

getClassImportFilterback to summary
public ClassFilter getClassImportFilter()

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

Returns:ClassFilter

the class import filter to use

getExportFilterback to summary
public PathFilter getExportFilter()

Get the export filter to use. The default value is PathFilters#rejectAll().

Returns:PathFilter

the export filter to use

getImportFilterback to summary
public PathFilter getImportFilter()

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

Returns:PathFilter

the import filter to use

getResourceExportFilterback to summary
public PathFilter getResourceExportFilter()

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

Returns:PathFilter

the resource export filter to use

getResourceImportFilterback to summary
public PathFilter getResourceImportFilter()

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

Returns:PathFilter

the resource import filter to use

setClassExportFilterback to summary
public DependencySpecBuilder setClassExportFilter(final ClassFilter classExportFilter)

Set the class export filter to use.

Parameters
classExportFilter:ClassFilter

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

Returns:DependencySpecBuilder

this builder

setClassImportFilterback to summary
public DependencySpecBuilder setClassImportFilter(final ClassFilter classImportFilter)

Set the class import filter to use.

Parameters
classImportFilter:ClassFilter

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

Returns:DependencySpecBuilder

this builder

setExportback to summary
public DependencySpecBuilder setExport(final boolean export)

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:DependencySpecBuilder

this builder

setExportFilterback to summary
public DependencySpecBuilder setExportFilter(final PathFilter exportFilter)

Set the export filter to use.

Parameters
exportFilter:PathFilter

the export filter to use (must not be null)

Returns:DependencySpecBuilder

this builder

setImportFilterback to summary
public DependencySpecBuilder setImportFilter(final PathFilter importFilter)

Set the import filter to use.

Parameters
importFilter:PathFilter

the import filter to use (must not be null)

Returns:DependencySpecBuilder

this builder

setImportServicesback to summary
public DependencySpecBuilder setImportServices(final boolean services)

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:DependencySpecBuilder

this builder

setResourceExportFilterback to summary
public DependencySpecBuilder setResourceExportFilter(final PathFilter resourceExportFilter)

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:DependencySpecBuilder

this builder

setResourceImportFilterback to summary
public DependencySpecBuilder setResourceImportFilter(final PathFilter resourceImportFilter)

Set the resource import filter to use.

Parameters
resourceImportFilter:PathFilter

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

Returns:DependencySpecBuilder

this builder