Package org.jboss.as.server.deployment.module

Class ModuleDependency

java.lang.Object

org.jboss.as.server.deployment.module.ModuleDependency

All Implemented Interfaces:

Serializable

public final class ModuleDependency
extends Object
implements Serializable

Author:

John E. Bailey, David M. Lloyd

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModuleDependency.Builder

Constructor Summary

Constructors

Constructor	Description
ModuleDependency(org.jboss.modules.ModuleLoader moduleLoader, String identifier, boolean optional, boolean export, boolean importServices, boolean userSpecified)	Construct a new instance.
ModuleDependency(org.jboss.modules.ModuleLoader moduleLoader, String identifier, boolean optional, boolean export, boolean importServices, boolean userSpecified, String reason)	Deprecated, for removal: This API element is subject to removal in a future version. Use a ModuleDependency.Builder
ModuleDependency(org.jboss.modules.ModuleLoader moduleLoader, org.jboss.modules.ModuleIdentifier identifier, boolean optional, boolean export, boolean importServices, boolean userSpecified)	Deprecated, for removal: This API element is subject to removal in a future version. Use a ModuleDependency.Builder or ModuleDependency(org.jboss.modules.ModuleLoader,java.lang.String,boolean,boolean,boolean,boolean)
ModuleDependency(org.jboss.modules.ModuleLoader moduleLoader, org.jboss.modules.ModuleIdentifier identifier, boolean optional, boolean export, boolean importServices, boolean userSpecified, String reason)	Deprecated, for removal: This API element is subject to removal in a future version. Use a ModuleDependency.Builder

Method Summary

Modifier and Type	Method	Description
void	addExportFilter(org.jboss.modules.filter.PathFilter pathFilter, boolean include)
void	addImportFilter(org.jboss.modules.filter.PathFilter pathFilter, boolean include)
boolean	equals(Object o)
String	getDependencyModule()	Gets the name of the module upon which there is a dependency.
List<FilterSpecification>	getExportFilters()
org.jboss.modules.ModuleIdentifier	getIdentifier()	Deprecated, for removal: This API element is subject to removal in a future version. use getDependencyModule()
List<FilterSpecification>	getImportFilters()
org.jboss.modules.ModuleLoader	getModuleLoader()
Optional<String>	getReason()
int	hashCode()
boolean	isExport()
boolean	isImportServices()
boolean	isOptional()
boolean	isUserSpecified()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleDependency

public ModuleDependency(org.jboss.modules.ModuleLoader moduleLoader,
                        String identifier,
                        boolean optional,
                        boolean export,
                        boolean importServices,
                        boolean userSpecified)

Construct a new instance.

Parameters:

moduleLoader - the module loader of the dependency (if null, then use the default server module loader)

identifier - the module identifier

optional - true if this is an optional dependency

export - true if resources should be exported by default

importServices - true if the dependent module should be able to load services from the dependency

userSpecified - true if this dependency was specified by the user, false if it was automatically added

ModuleDependency

@Deprecated(forRemoval=true)
public ModuleDependency(org.jboss.modules.ModuleLoader moduleLoader,
                        String identifier,
                        boolean optional,
                        boolean export,
                        boolean importServices,
                        boolean userSpecified,
                        String reason)

Deprecated, for removal: This API element is subject to removal in a future version.

Use a ModuleDependency.Builder

Construct a new instance.

Parameters:

moduleLoader - the module loader of the dependency (if null, then use the default server module loader)

identifier - the module identifier

optional - true if this is an optional dependency

export - true if resources should be exported by default

importServices - true if the dependent module should be able to load services from the dependency

userSpecified - true if this dependency was specified by the user, false if it was automatically added

reason - reason for adding implicit module dependency

ModuleDependency

@Deprecated(forRemoval=true)
public ModuleDependency(org.jboss.modules.ModuleLoader moduleLoader,
                        org.jboss.modules.ModuleIdentifier identifier,
                        boolean optional,
                        boolean export,
                        boolean importServices,
                        boolean userSpecified)

Deprecated, for removal: This API element is subject to removal in a future version.

Use a ModuleDependency.Builder or ModuleDependency(org.jboss.modules.ModuleLoader,java.lang.String,boolean,boolean,boolean,boolean)

Construct a new instance.

Parameters:

moduleLoader - the module loader of the dependency (if null, then use the default server module loader)

identifier - the module identifier

optional - true if this is an optional dependency

export - true if resources should be exported by default

importServices - true if the dependent module should be able to load services from the dependency

userSpecified - true if this dependency was specified by the user, false if it was automatically added

ModuleDependency

@Deprecated(forRemoval=true)
public ModuleDependency(org.jboss.modules.ModuleLoader moduleLoader,
                        org.jboss.modules.ModuleIdentifier identifier,
                        boolean optional,
                        boolean export,
                        boolean importServices,
                        boolean userSpecified,
                        String reason)

Deprecated, for removal: This API element is subject to removal in a future version.

Use a ModuleDependency.Builder

Construct a new instance.

Parameters:

moduleLoader - the module loader of the dependency (if null, then use the default server module loader)

identifier - the module identifier

optional - true if this is an optional dependency

export - true if resources should be exported by default

importServices - true if the dependent module should be able to load services from the dependency

userSpecified - true if this dependency was specified by the user, false if it was automatically added

reason - reason for adding implicit module dependency

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getModuleLoader

public org.jboss.modules.ModuleLoader getModuleLoader()

getIdentifier

@Deprecated(forRemoval=true)
public org.jboss.modules.ModuleIdentifier getIdentifier()

Deprecated, for removal: This API element is subject to removal in a future version.

use getDependencyModule()

getDependencyModule

public String getDependencyModule()

Gets the name of the module upon which there is a dependency.

Returns:

the canonical form of the name of module

getReason

public Optional<String> getReason()

isOptional

public boolean isOptional()

isExport

public boolean isExport()

isUserSpecified

public boolean isUserSpecified()

addImportFilter

public void addImportFilter(org.jboss.modules.filter.PathFilter pathFilter,
                            boolean include)

getImportFilters

public List<FilterSpecification> getImportFilters()

addExportFilter

public void addExportFilter(org.jboss.modules.filter.PathFilter pathFilter,
                            boolean include)

getExportFilters

public List<FilterSpecification> getExportFilters()

isImportServices

public boolean isImportServices()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object