com.ibm.jaggr.core.util

Class DependencyList

java.lang.Object

com.ibm.jaggr.core.util.DependencyList

public class DependencyList
extends Object

Container class for the set of expanded dependencies for a list of modules.

Constructor Summary

Constructors

Constructor and Description
DependencyList(ModuleDeps explicitDeps, ModuleDeps expandedDeps, Set<String> dependentFeatures) Constructs a DependencyList from pre-specified values
DependencyList(String source, Iterable<String> names, IAggregator aggr, Features features, boolean resolveAliases, boolean includeDetails) Object constructor.
DependencyList(String source, Iterable<String> names, IAggregator aggr, Features features, boolean resolveAliases, boolean includeDetails, boolean includeRequireDeps) Object constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getDependentFeatures() Returns the set of features that were discovered when evaluating has! plugin expressions or aliases when expanding the dependencies.
ModuleDeps	getExpandedDeps() Returns the set of expanded dependencies for the modules specified in names.
ModuleDeps	getExplicitDeps() Returns the explicit dependencies for the modules specified in names.
String	getLabel() Returns the label set by setLabel(String)
void	setCoerceUndefinedToFalse(boolean state)
void	setLabel(String label) Associates an arbitrary text string with this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DependencyList

public DependencyList(String source,
              Iterable<String> names,
              IAggregator aggr,
              Features features,
              boolean resolveAliases,
              boolean includeDetails)

Object constructor. Note that resolution of expanded dependencies is not done at object creation time, but rather, the first time that one of the accessors is called.

Parameters:

source - The declaring source. Included in diagnostic details.

names - The list of normalized module ids for which expanded dependencies are needed.

aggr - The aggregator servlet

features - The map of feature-name value pairs to use for resolving has! plugin expressions and aliases

resolveAliases - Flag indicating if alias resolution should be performed on the module ids specified in names. (Note: alias resolution is always performed for expanded dependencies.

includeDetails - Flag indicating if diagnostic details should be included with the expanded dependencies

DependencyList

public DependencyList(String source,
              Iterable<String> names,
              IAggregator aggr,
              Features features,
              boolean resolveAliases,
              boolean includeDetails,
              boolean includeRequireDeps)

Object constructor. Note that resolution of expanded dependencies is not done at object creation time, but rather, the first time that one of the accessors is called.

Parameters:

source - The declaring source. Included in diagnostic details.

names - The list of normalized module ids for which expanded dependencies are needed.

aggr - The aggregator servlet

features - The map of feature-name value pairs to use for resolving has! plugin expressions and aliases

resolveAliases - Flag indicating if alias resolution should be performed on the module ids specified in names. (Note: alias resolution is always performed for expanded dependencies.

includeDetails - Flag indicating if diagnostic details should be included with the expanded dependencies

includeRequireDeps - Flag indicating whether or not to include dependencies specified in require() calls.

DependencyList

public DependencyList(ModuleDeps explicitDeps,
              ModuleDeps expandedDeps,
              Set<String> dependentFeatures)

Constructs a DependencyList from pre-specified values

Parameters:

explicitDeps -

expandedDeps -

dependentFeatures -

Method Detail

getExplicitDeps

public ModuleDeps getExplicitDeps()
                           throws IOException

Returns the explicit dependencies for the modules specified in names. This includes the specified modules, plus any module names resulting from resolving has! plugin expressions and aliases for the specified modules.

The set of explicit dependencies is the key set of the returned map. The value set of the map contains diagnostic details regarding the dependency expansion of each module if includeDetails was true when the object was constructed. Otherwise, the value objects will all be null.

Returns:

The explicit dependencies for the modules specified in names.

Throws:

IOException

getExpandedDeps

public ModuleDeps getExpandedDeps()
                           throws IOException

Returns the set of expanded dependencies for the modules specified in names. This set generally does not include the modules specified in names, but is is not exclusive of that list either. A module specified in names may be included in the result by virtue of being a dependency of another module.

The set of expanded names is the key set of the returned map. The value set of the map contains diagnostic details regarding the dependency expansion of each module if includeDetails was true when the object was constructed. Otherwise, the value objects will all be null.

Returns:

The expanded dependencies for the modules specified in names.

Throws:

IOException

getDependentFeatures

public Set<String> getDependentFeatures()
                                 throws IOException

Returns the set of features that were discovered when evaluating has! plugin expressions or aliases when expanding the dependencies. This information may be required by the cache manager in order to properly idenify cached responses.

Returns:

The set of discovered feature names.

Throws:

IOException

setLabel

public void setLabel(String label)

Associates an arbitrary text string with this object.

Parameters:

label - The string to associate with this object

setCoerceUndefinedToFalse

public void setCoerceUndefinedToFalse(boolean state)

getLabel

public String getLabel()

Returns the label set by setLabel(String)

Returns:

The previously set label string