com.ibm.jaggr.core.deps

Class ModuleDeps

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,ModuleDepInfo>

com.ibm.jaggr.core.deps.ModuleDeps

All Implemented Interfaces:

Serializable, Cloneable, Map<String,ModuleDepInfo>

public class ModuleDeps
extends LinkedHashMap<String,ModuleDepInfo>
implements Serializable

This class extends LinkedHashMap to provide additional methods for managing a map of module names to ModuleDepInfo objects. This class is not thread safe, so external provisions for thread safety need to be made if instances of this class are to be shared by multiple threads.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors

Constructor and Description
ModuleDeps()
ModuleDeps(ModuleDeps other) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(String key, ModuleDepInfo info) Adds the specified pair to the map.
boolean	addAll(ModuleDeps other) Adds all of the map entries from other to this map
ModuleDeps	andWith(ModuleDepInfo info) Calls ModuleDepInfo.andWith(ModuleDepInfo) on each of the entries in this list.
boolean	containsDep(String moduleName, BooleanTerm term) Returns true if the map contains the module name with the specified term.
Set<String>	getModuleIds() Provided for backwards compatibility
Set<String>	getModuleIds(Map<?,?> formulaCache) Returns a set of module ids for the keys in this map.
Map<String,String>	getModuleIdsWithComments() Returns a map of module ids with comments for the keys in this map.
ModuleDepInfo	put(String key, ModuleDepInfo value)
void	putAll(Map<? extends String,? extends ModuleDepInfo> map)
ModuleDeps	resolveWith(Features features) Calls ModuleDepInfo.resolveWith(Features) on each of the values in the map.
ModuleDeps	resolveWith(Features features, boolean coerceUndefinedToFalse) Calls ModuleDepInfo.resolveWith(Features) on each of the values in the map.
ModuleDeps	simplify(Map<?,?> formulaCache) Simplifies the boolean formulas for each contained ModuleDepInfo
boolean	subtract(String key, ModuleDepInfo subInfo) Subtracts the terms in subInfo from the terms in the module dep info object associated with the specified key.
boolean	subtractAll(ModuleDeps toSub) Calls subtract(String, ModuleDepInfo) for each of the map entries in toSub

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, get, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, containsKey, entrySet, isEmpty, keySet, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

containsKey, entrySet, equals, hashCode, isEmpty, keySet, remove, size, values

Constructor Detail

ModuleDeps

public ModuleDeps()

ModuleDeps

public ModuleDeps(ModuleDeps other)

Copy constructor. Creates a deep copy (clones the ModuleDepInfo objects) of other.

Parameters:

other -

Method Detail

add

public boolean add(String key,
          ModuleDepInfo info)

Adds the specified pair to the map. If an entry for the key exists, then the specified module dep info is added to the existing module dep info.

Parameters:

key - The module name to associate with the dep info object

info - the ModuleDepInfo object

Returns:

true if the map was modified

addAll

public boolean addAll(ModuleDeps other)

Adds all of the map entries from other to this map

Parameters:

other - the map containing entries to add

Returns:

true if the map was modified

containsDep

public boolean containsDep(String moduleName,
                  BooleanTerm term)

Returns true if the map contains the module name with the specified term. See ModuleDepInfo.containsTerm(BooleanTerm) for a description of containment.

Parameters:

moduleName - The module name

term - the boolean term

Returns:

True if the map contains the module name with the specified term.

andWith

public ModuleDeps andWith(ModuleDepInfo info)

Calls ModuleDepInfo.andWith(ModuleDepInfo) on each of the entries in this list.

Parameters:

info - the ModuleDepInfo who's formula will be anded with the entries in the list.

Returns:

this object.

subtract

public boolean subtract(String key,
               ModuleDepInfo subInfo)

Subtracts the terms in subInfo from the terms in the module dep info object associated with the specified key.

See ModuleDepInfo.subtract(ModuleDepInfo) for a description of what it means to subtract boolean terms.

Parameters:

key - The module name

subInfo - The object containing the terms to subtract

Returns:

true if this map was modified

subtractAll

public boolean subtractAll(ModuleDeps toSub)

Calls subtract(String, ModuleDepInfo) for each of the map entries in toSub

Parameters:

toSub - The map to subtract from this map

Returns:

True if this map was modified

getModuleIds

public Set<String> getModuleIds()

Provided for backwards compatibility

Returns:

The set of module ids

getModuleIds

public Set<String> getModuleIds(Map<?,?> formulaCache)

Returns a set of module ids for the keys in this map. If the module dep info objects associated with a key specifies has plugin prefixes, then the entries will include the prefixes. Note that one map entry may result in multiple (or zero) result entries depending on the evaluation of the boolean formula which represents the has conditionals.

Parameters:

formulaCache - the formula cache or null

Returns:

The set of module ids

getModuleIdsWithComments

public Map<String,String> getModuleIdsWithComments()

Returns a map of module ids with comments for the keys in this map. If the module dep info objects associated with a key specifies has plugin prefixes, then the entries will include the prefixes. Note that one map entry may result in multiple (or zero) result entries depending on the evaluation of the boolean formula which represents the has conditionals.

Returns:

The map of module id, comment pairs

resolveWith

public ModuleDeps resolveWith(Features features)

Calls ModuleDepInfo.resolveWith(Features) on each of the values in the map.

Parameters:

features - the feature set to apply.

Returns:

the current object

resolveWith

public ModuleDeps resolveWith(Features features,
                     boolean coerceUndefinedToFalse)

Calls ModuleDepInfo.resolveWith(Features) on each of the values in the map.

Parameters:

features - the feature set to apply.

coerceUndefinedToFalse - if true, undefined features will be treated as false

Returns:

the current object

simplify

public ModuleDeps simplify(Map<?,?> formulaCache)

Simplifies the boolean formulas for each contained ModuleDepInfo

Parameters:

formulaCache - the formula cache

Returns:

this object

put

public ModuleDepInfo put(String key,
                ModuleDepInfo value)

Specified by:

put in interface Map<String,ModuleDepInfo>

Overrides:

put in class HashMap<String,ModuleDepInfo>

putAll

public void putAll(Map<? extends String,? extends ModuleDepInfo> map)

Specified by:

putAll in interface Map<String,ModuleDepInfo>

Overrides:

putAll in class HashMap<String,ModuleDepInfo>