Package org.jboss.modules
Class DependencySpec
- java.lang.Object
-
- org.jboss.modules.DependencySpec
-
- Direct Known Subclasses:
ModuleDependencySpec
public abstract class DependencySpec extends Object
A dependency specification that represents a single dependency for a module. The dependency can be on a local loader or another module, or on the target module's local loader.- Author:
- David M. Lloyd, John Bailey, Jason T. Greene
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DependencySpec
createClassLoaderDependencySpec(ClassLoader classLoader, Set<String> loaderPaths)
Create a dependency on the given class loader.static DependencySpec
createClassLoaderDependencySpec(ClassLoader classLoader, Set<String> loaderPaths, boolean export)
Create a dependency on the given class loader.static DependencySpec
createClassLoaderDependencySpec(PathFilter importFilter, PathFilter exportFilter, ClassLoader classLoader, Set<String> loaderPaths)
Create a dependency on the given class loader.static DependencySpec
createLocalDependencySpec()
Create a dependency on the current module's local resources.static DependencySpec
createLocalDependencySpec(PathFilter importFilter, PathFilter exportFilter)
Create a dependency on the current module's local resources.static DependencySpec
createLocalDependencySpec(PathFilter importFilter, PathFilter exportFilter, PathFilter resourceImportFilter, PathFilter resourceExportFilter, ClassFilter classImportFilter, ClassFilter classExportFilter)
Create a dependency on the current module's local resources.static DependencySpec
createLocalDependencySpec(PathFilter importFilter, PathFilter exportFilter, PathFilter resourceImportFilter, PathFilter resourceExportFilter, ClassFilter classImportFilter, ClassFilter classExportFilter, LocalLoader localLoader, Set<String> loaderPaths)
Create a dependency on the given local loader.static DependencySpec
createLocalDependencySpec(PathFilter importFilter, PathFilter exportFilter, LocalLoader localLoader, Set<String> loaderPaths)
Create a dependency on the given local loader.static DependencySpec
createLocalDependencySpec(LocalLoader localLoader, Set<String> loaderPaths)
Create a dependency on the given local loader.static DependencySpec
createLocalDependencySpec(LocalLoader localLoader, Set<String> loaderPaths, boolean export)
Create a dependency on the given local loader.static DependencySpec
createModuleDependencySpec(PathFilter importFilter, PathFilter exportFilter, PathFilter resourceImportFilter, PathFilter resourceExportFilter, ClassFilter classImportFilter, ClassFilter classExportFilter, ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean optional)
Create a dependency on the given module.static DependencySpec
createModuleDependencySpec(PathFilter importFilter, PathFilter exportFilter, ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean optional)
Create a dependency on the given module.static DependencySpec
createModuleDependencySpec(PathFilter exportFilter, ModuleIdentifier identifier, boolean optional)
Create a dependency on the given module.static DependencySpec
createModuleDependencySpec(PathFilter exportFilter, ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean optional)
Create a dependency on the given module.static DependencySpec
createModuleDependencySpec(ModuleIdentifier identifier)
Create a dependency on the given module.static DependencySpec
createModuleDependencySpec(ModuleIdentifier identifier, boolean export)
Create a dependency on the given module.static DependencySpec
createModuleDependencySpec(ModuleIdentifier identifier, boolean export, boolean optional)
Create a dependency on the given module.static DependencySpec
createModuleDependencySpec(ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean export)
Create a dependency on the given module.static DependencySpec
createModuleDependencySpec(ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean export, boolean optional)
Create a dependency on the given module.static DependencySpec
createSystemDependencySpec(Set<String> loaderPaths)
Create a system dependency.static DependencySpec
createSystemDependencySpec(Set<String> loaderPaths, boolean export)
Create a system dependency.static DependencySpec
createSystemDependencySpec(PathFilter importFilter, PathFilter exportFilter, Set<String> loaderPaths)
Create a system dependency.ClassFilter
getClassExportFilter()
Get the dependency class export filter.ClassFilter
getClassImportFilter()
Get the dependency class import filter.PathFilter
getExportFilter()
Get the dependency export filter.PathFilter
getImportFilter()
Get the dependency import filter.PathFilter
getResourceExportFilter()
Get the dependency resource export filter.PathFilter
getResourceImportFilter()
Get the dependency resource import filter.
-
-
-
Method Detail
-
getImportFilter
public PathFilter getImportFilter()
Get the dependency import filter.- Returns:
- the import filter
-
getExportFilter
public PathFilter getExportFilter()
Get the dependency export filter.- Returns:
- the export filter
-
getResourceImportFilter
public PathFilter getResourceImportFilter()
Get the dependency resource import filter.- Returns:
- the import filter
-
getResourceExportFilter
public PathFilter getResourceExportFilter()
Get the dependency resource export filter.- Returns:
- the export filter
-
getClassImportFilter
public ClassFilter getClassImportFilter()
Get the dependency class import filter.- Returns:
- the class import filter
-
getClassExportFilter
public ClassFilter getClassExportFilter()
Get the dependency class export filter.- Returns:
- the class export filter
-
createLocalDependencySpec
public static DependencySpec createLocalDependencySpec()
Create a dependency on the current module's local resources. You should have at least one such dependency on any module which has its own resources.- Returns:
- the dependency spec
-
createLocalDependencySpec
public static DependencySpec createLocalDependencySpec(PathFilter importFilter, PathFilter exportFilter)
Create a dependency on the current module's local resources. You should have at least one such dependency on any module which has its own resources.- Parameters:
importFilter
- the import filter to applyexportFilter
- the export filter to apply- Returns:
- the dependency spec
-
createLocalDependencySpec
public static DependencySpec createLocalDependencySpec(PathFilter importFilter, PathFilter exportFilter, PathFilter resourceImportFilter, PathFilter resourceExportFilter, ClassFilter classImportFilter, ClassFilter classExportFilter)
Create a dependency on the current module's local resources. You should have at least one such dependency on any module which has its own resources.- Parameters:
importFilter
- the import filter to applyexportFilter
- the export filter to applyresourceImportFilter
- the resource import filter to applyresourceExportFilter
- the resource export filter to applyclassImportFilter
- the class import filter to applyclassExportFilter
- the class export filter to apply- Returns:
- the dependency spec
-
createSystemDependencySpec
public static DependencySpec createSystemDependencySpec(Set<String> loaderPaths)
Create a system dependency.- Parameters:
loaderPaths
- the set of paths to use from the system class loader- Returns:
- the dependency spec
-
createSystemDependencySpec
public static DependencySpec createSystemDependencySpec(Set<String> loaderPaths, boolean export)
Create a system dependency.- Parameters:
loaderPaths
- the set of paths to use from the system class loaderexport
-true
if this is a fully re-exported dependency,false
if it should not be exported- Returns:
- the dependency spec
-
createSystemDependencySpec
public static DependencySpec createSystemDependencySpec(PathFilter importFilter, PathFilter exportFilter, Set<String> loaderPaths)
Create a system dependency.- Parameters:
importFilter
- the import filter to applyexportFilter
- the export filter to applyloaderPaths
- the set of paths to use from the system class loader- Returns:
- the dependency spec
-
createClassLoaderDependencySpec
public static DependencySpec createClassLoaderDependencySpec(ClassLoader classLoader, Set<String> loaderPaths)
Create a dependency on the given class loader.- Parameters:
classLoader
- the class loaderloaderPaths
- the set of paths to use from this class loader- Returns:
- the dependency spec
-
createClassLoaderDependencySpec
public static DependencySpec createClassLoaderDependencySpec(ClassLoader classLoader, Set<String> loaderPaths, boolean export)
Create a dependency on the given class loader.- Parameters:
classLoader
- the class loaderloaderPaths
- the set of paths to use from this class loaderexport
-true
if this is a fully re-exported dependency,false
if it should not be exported- Returns:
- the dependency spec
-
createClassLoaderDependencySpec
public static DependencySpec createClassLoaderDependencySpec(PathFilter importFilter, PathFilter exportFilter, ClassLoader classLoader, Set<String> loaderPaths)
Create a dependency on the given class loader.- Parameters:
importFilter
- the import filter to applyexportFilter
- the export filter to applyclassLoader
- the class loaderloaderPaths
- the set of paths to use from this class loader- Returns:
- the dependency spec
-
createLocalDependencySpec
public static DependencySpec createLocalDependencySpec(LocalLoader localLoader, Set<String> loaderPaths)
Create a dependency on the given local loader.- Parameters:
localLoader
- the local loaderloaderPaths
- the set of paths that is exposed by the local loader- Returns:
- the dependency spec
-
createLocalDependencySpec
public static DependencySpec createLocalDependencySpec(LocalLoader localLoader, Set<String> loaderPaths, boolean export)
Create a dependency on the given local loader.- Parameters:
localLoader
- the local loaderloaderPaths
- the set of paths that is exposed by the local loaderexport
-true
if this is a fully re-exported dependency,false
if it should not be exported- Returns:
- the dependency spec
-
createLocalDependencySpec
public static DependencySpec createLocalDependencySpec(PathFilter importFilter, PathFilter exportFilter, LocalLoader localLoader, Set<String> loaderPaths)
Create a dependency on the given local loader.- Parameters:
importFilter
- the import filter to applyexportFilter
- the export filter to applylocalLoader
- the local loaderloaderPaths
- the set of paths that is exposed by the local loader- Returns:
- the dependency spec
-
createLocalDependencySpec
public static DependencySpec createLocalDependencySpec(PathFilter importFilter, PathFilter exportFilter, PathFilter resourceImportFilter, PathFilter resourceExportFilter, ClassFilter classImportFilter, ClassFilter classExportFilter, LocalLoader localLoader, Set<String> loaderPaths)
Create a dependency on the given local loader.- Parameters:
importFilter
- the import filter to applyexportFilter
- the export filter to applyresourceImportFilter
- the resource import filter to applyresourceExportFilter
- the resource export filter to applyclassImportFilter
- the class import filter to applyclassExportFilter
- the class export filter to applylocalLoader
- the local loaderloaderPaths
- the set of paths that is exposed by the local loader- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(ModuleIdentifier identifier)
Create a dependency on the given module.- Parameters:
identifier
- the module identifier- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(ModuleIdentifier identifier, boolean export)
Create a dependency on the given module.- Parameters:
identifier
- the module identifierexport
-true
if the dependency should be exported by default- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(ModuleIdentifier identifier, boolean export, boolean optional)
Create a dependency on the given module.- Parameters:
identifier
- the module identifierexport
-true
if this is a fully re-exported dependency,false
if it should not be exportedoptional
-true
if the dependency is optional,false
if it is mandatory- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean export)
Create a dependency on the given module.- Parameters:
moduleLoader
- the specific module loader from which the module should be acquiredidentifier
- the module identifierexport
-true
if this is a fully re-exported dependency,false
if it should not be exported- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean export, boolean optional)
Create a dependency on the given module.- Parameters:
moduleLoader
- the specific module loader from which the module should be acquiredidentifier
- the module identifierexport
-true
if this is a fully re-exported dependency,false
if it should not be exportedoptional
-true
if the dependency is optional,false
if it is mandatory- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(PathFilter exportFilter, ModuleIdentifier identifier, boolean optional)
Create a dependency on the given module.- Parameters:
exportFilter
- the export filter to applyidentifier
- the module identifieroptional
-true
if the dependency is optional,false
if it is mandatory- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(PathFilter exportFilter, ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean optional)
Create a dependency on the given module.- Parameters:
exportFilter
- the export filter to applymoduleLoader
- the specific module loader from which the module should be acquiredidentifier
- the module identifieroptional
-true
if the dependency is optional,false
if it is mandatory- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(PathFilter importFilter, PathFilter exportFilter, ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean optional)
Create a dependency on the given module.- Parameters:
importFilter
- the import filter to applyexportFilter
- the export filter to applymoduleLoader
- the specific module loader from which the module should be acquiredidentifier
- the module identifieroptional
-true
if the dependency is optional,false
if it is mandatory- Returns:
- the dependency spec
-
createModuleDependencySpec
public static DependencySpec createModuleDependencySpec(PathFilter importFilter, PathFilter exportFilter, PathFilter resourceImportFilter, PathFilter resourceExportFilter, ClassFilter classImportFilter, ClassFilter classExportFilter, ModuleLoader moduleLoader, ModuleIdentifier identifier, boolean optional)
Create a dependency on the given module.- Parameters:
importFilter
- the import filter to applyexportFilter
- the export filter to applyresourceImportFilter
- the resource import filter to applyresourceExportFilter
- the resource export filter to applyclassImportFilter
- the class import filter to applyclassExportFilter
- the class export filter to applymoduleLoader
- the specific module loader from which the module should be acquiredidentifier
- the module identifieroptional
-true
if the dependency is optional,false
if it is mandatory- Returns:
- the dependency spec
-
-