com.ibm.jaggr.core.deps

Interface IDependencies

All Known Implementing Classes:

DependenciesImpl

public interface IDependencies

This class encapsulates the dependency graph of a collection of AMD modules. The modules included in the graph are those modules found when scanning the locations returned by IConfig.getPaths() and IConfig.getPackageLocations(). The dependencies of a module are those modules listed in the require list of the define() function call within the module. The expanded dependencies for a module include the explicitly declared dependencies, plus all of the nested dependencies obtained by including the dependencies of the explicitly dependent modules, plus their dependencies, and so on.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	defaultNonJSExtensions Default non-JavaScript file extensions to include in the scanned dependencies names list returned by getDependencyNames().
static Collection<String>	excludes Module names to be excluded when expanding.
static String	nonJSExtensionsCfgPropName Name of config property specifying optional additional file extension names to include in the scanned dependencies name list returned by getDependencyNames().

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getDelcaredDependencies(String mid) Returns the dependencies for the specified module.
Iterable<String>	getDependencyNames() Returns an Iterable over the module names that were scanned while building the dependency map.
List<String>	getDependentFeatures(String mid) Returns the list of dependent features for the specified module.
long	getLastModified() Returns the cumulative last-modified date of these dependencies which was determined the last time the dependencies were created or validated.
List<String>	getRequireDependencies(String mid) Returns the list of modules specified in the dependency lists of any require calls contained within the specified module.
URI	getURI(String mid) Returns the resource URI for the specified module id.
void	validateDeps(boolean clean) Validates the dependency graph by scanning the directories returned by IConfig.getPaths() and IConfig.getPackageLocations() looking for new/changed/removed files and updating the dependency graph, including the dependency graph last-modified timestamp, as needed.

Field Detail

excludes

static final Collection<String> excludes

Module names to be excluded when expanding. These are pseudo modules that don't resolve to actual module resources.

defaultNonJSExtensions

static final String[] defaultNonJSExtensions

Default non-JavaScript file extensions to include in the scanned dependencies names list returned by getDependencyNames().

nonJSExtensionsCfgPropName

static final String nonJSExtensionsCfgPropName

Name of config property specifying optional additional file extension names to include in the scanned dependencies name list returned by getDependencyNames().

See Also:

Constant Field Values

Method Detail

getDelcaredDependencies

List<String> getDelcaredDependencies(String mid)
                                     throws ProcessingDependenciesException

Returns the dependencies for the specified module. This is the list of modules listed in the module's define function. The module ids are normalized to remove relative paths.

Parameters:

mid - The module id

Returns:

An unmodifiable list of explicitly specified dependent modules, or null if the specified module was not found when the dependencies were processed.

Throws:

ProcessingDependenciesException

getRequireDependencies

List<String> getRequireDependencies(String mid)
                                    throws ProcessingDependenciesException

Returns the list of modules specified in the dependency lists of any require calls contained within the specified module. If the specified module does not contain any require calls, then an empty list is returned.

Note that no attempt is made to determine if the require call will ever be executed by the client by looking for dead code, etc. Any require calls that appear within the module will be used in collecting require dependencies.

Parameters:

mid - The module id

Returns:

An unmodifiable list of require call dependencies, or null if the specified module was not found when the dependencies were processed.

Throws:

ProcessingDependenciesException

getDependentFeatures

List<String> getDependentFeatures(String mid)
                                  throws ProcessingDependenciesException

Returns the list of dependent features for the specified module. This includes features specified as string literals in has() function calls, as well as features specified using a has! loader plugin in require and define dependency lists.

Note that not all feature names used in has() function calls may be returned in this list. Only features that are used in has() function calls who's return value is used as a boolean are included (e.g. if (has('isIE')) { ). If the result of the has function call is used as another type, then the feature may not be be included in the returned list (e.g. var isIE = has('isIE'); or if (has('isIE') < 8) { ). This is because feature values are specified in aggregator requests as booleans, so aggregator optimizations based on defined features may not be safely performed if the result of a feature evaluation is used as a type other than boolean.

Parameters:

mid - the module id

Returns:

an unmodifiable list of the dependent features, or null if the specified module was not found when the dependencies were processed.

Throws:

ProcessingDependenciesException

getURI

URI getURI(String mid)
           throws ProcessingDependenciesException

Returns the resource URI for the specified module id. Module ids returned by getDependencyNames() will return a non-null value. Any other value passed for mid will result in a return value of null.

Parameters:

mid - the module id

Returns:

the resource URI for the module, or null

Throws:

ProcessingDependenciesException

getDependencyNames

Iterable<String> getDependencyNames()
                                    throws ProcessingDependenciesException

Returns an Iterable over the module names that were scanned while building the dependency map. This includes JavaScript modules as well as selected non-JavaScript modules.

Non-JavaScript modules included in the result include the following:

• modules with extensions specified in defaultNonJSExtensions
• modules with extensions specified in the server-side config property named nonJSExtensionsCfgPropName
• modules with extensions specified by the IModuleBuilderExtensionPoint.EXTENSION_ATTRIBUTE config property for the registered module builders

Only JavaScript modules have dependencies. If a non-JavaScript module included in the result is passed to getDelcaredDependencies(String) or getDependentFeatures(String), an empty list will be returned.

Returns:

the module names in the dependency map.

Throws:

ProcessingDependenciesException

getLastModified

long getLastModified()

Returns the cumulative last-modified date of these dependencies which was determined the last time the dependencies were created or validated. In general, changes to source files which do not affect the dependencies do not cause this value to be updated, however, the addition or removal of dependencies within a dependent file cause the value returned from this method to reflect the most recent last-modified date of those files containing such changes at the time that they are detected.

Returns:

The cumulative last modified date of the module dependencies

validateDeps

void validateDeps(boolean clean)

Validates the dependency graph by scanning the directories returned by IConfig.getPaths() and IConfig.getPackageLocations() looking for new/changed/removed files and updating the dependency graph, including the dependency graph last-modified timestamp, as needed.

Parameters:

clean - If true, then any cached or previously calculated dependency graph is discarded and a new graph is generated from scratch. Use this option if file or directory last-modified dates cannot be relied upon to accurately reflect the changed state of the module files included in the graph.