com.google.gwt.dev.cfg

Class ModuleDef

java.lang.Object

com.google.gwt.dev.cfg.ModuleDef

All Implemented Interfaces:

DepsInfoProvider

public class ModuleDef
extends Object
implements DepsInfoProvider

Represents a module specification. In principle, this could be built without XML for unit tests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleDef.ModuleType Marks a module in a way that can be used to calculate the effective bounds of a library module in a module tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceOracleImpl	lazyPublicOracle All resources found on the public path, specified by directives in modules (or the implicit ./public directory).

Constructor Summary

Constructors

Constructor and Description
ModuleDef(String name)
ModuleDef(String name, ResourceLoader resources)
ModuleDef(String name, ResourceLoader resources, boolean monolithic, boolean mergePathPrefixes) Constructs a ModuleDef.

Method Summary

Modifier and Type	Method and Description
void	addDirectDependency(String currentModuleName, String dependencyModuleName) Register a dependencyModuleName as a directDependency of currentModuleName
void	addEntryPointTypeName(String typeName)
void	addFileset(String filesetModuleName) Registers a module as a fileset.
void	addGwtXmlFile(File xmlFile)
void	addLinker(String name)
void	addPublicPackage(String publicPackage, String[] includeList, String[] excludeList, String[] skipList, boolean defaultExcludes, boolean caseSensitive)
void	addResourcePath(String resourcePath)
void	addRule(Rule rule)
void	addSourcePackage(String sourcePackage, String[] includeList, String[] excludeList, String[] skipList, boolean defaultExcludes, boolean caseSensitive)
void	addSourcePackageImpl(String sourcePackage, String[] includeList, String[] excludeList, String[] skipList, boolean defaultExcludes, boolean caseSensitive, boolean isSuperSource)
void	addSuperSourcePackage(String superSourcePackage, String[] includeList, String[] excludeList, String[] skipList, boolean defaultExcludes, boolean caseSensitive)
void	clear() Free up memory no longer needed in later compile stages.
void	clearEntryPoints()
boolean	deactivateLinker(String linkerName) Deactivate a linker by name.
void	defineLinker(TreeLogger logger, String name, Class<? extends Linker> linker) Associate a Linker class with a symbolic name.
void	enterModule(ModuleDef.ModuleType moduleType, String canonicalModuleName) Called as module tree parsing enters and exits individual module file of various types and so provides the ModuleDef with an opportunity to keep track of what context it is currently operating. At the moment the ModuleDef uses it's monolithic property in combination with the entering modules ModuleType to updates its idea of attribute source.
void	exitModule()
Resource	findPublicFile(String partialPath)
String	findServletForPath(String actual)
Resource	findSourceFile(String partialPath) Returns the Resource for a source file if it is found; null otherwise.
Set<String>	getActiveLinkerNames()
Set<Class<? extends Linker>>	getActiveLinkers()
Class<? extends Linker>	getActivePrimaryLinker()
Collection<URL>	getAllCompilationUnitArchiveURLs() Returns URLs to fetch archives of precompiled compilation units.
String[]	getAllSourceFiles() Strictly for statistics gathering.
ResourceOracle	getBuildResourceOracle()
String	getCanonicalName() Returns the physical name for the module by which it can be found in the classpath.
CompilationState	getCompilationState(TreeLogger logger, CompilerContext compilerContext)
Collection<String>	getDirectDependencies(String libraryModuleName) The module names for its direct non fileset dependents.
String[]	getEntryPointTypeNames()
Set<String>	getExternalLibraryCanonicalModuleNames() Returns the names of free-standing compilable library modules that are depended upon by this module.
List<String>	getFileSetPathBetween(String fromModuleName, String toModuleName)
String	getFunctionName()
List<Rule>	getGeneratorRules()
String	getGwtXmlFilePath(String moduleName) Returns the .gwt.xml file path for the given module referenced by name.
int	getInputFilenameHash() Calculates a hash of the filenames of all the input files for the GWT compiler.
Class<? extends Linker>	getLinker(String name)
Map<String,Class<? extends Linker>>	getLinkers()
String	getName()
Properties	getProperties() The properties that have been defined.
ResourceOracleImpl	getPublicResourceOracle()
long	getResourceLastModified()
Set<Resource>	getResourcesNewerThan(long modificationTime)
Rules	getRules() Gets a reference to the internal rules for this module def.
Scripts	getScripts() Gets a reference to the internal scripts list for this module def.
String[]	getServletPaths()
Set<String>	getSourceModuleNames(String typeSourceName) Returns a set of the names of modules that source included the given type referenced by name.
ResourceOracle	getSourceResourceOracle()
Styles	getStyles() Gets a reference to the internal styles list for this module def.
Set<String>	getTargetLibraryCanonicalModuleNames() Returns the names of non-independently-compilable modules (mostly filesets) that together make up the current module.
Set<String>	getTransitiveDepModuleNames(String libraryModuleName) Returns a set of the names of modules in the transitive dependency tree for the given module referenced by name.
boolean	isGwtXmlFileStale()
boolean	isInherited(String moduleName)
static boolean	isValidModuleName(String moduleName)
long	lastModified()
void	mapServlet(String path, String servletClassName) For convenience in unit tests, servlets can be automatically loaded and mapped in the embedded web server.
void	printOverlappingSourceWarnings(TreeLogger logger)
void	recordModuleGwtXmlFile(String moduleName, String fileSourcePath)
void	refresh()
void	setCollapseAllProperties(boolean collapse) Mainly for testing and decreasing compile times.
void	setNameOverride(String nameOverride) Override the module's apparent name.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Field Detail

lazyPublicOracle

protected ResourceOracleImpl lazyPublicOracle

All resources found on the public path, specified by directives in modules (or the implicit ./public directory). Marked 'lazy' because it does not start searching for resources until a query is made.

Constructor Detail

ModuleDef

public ModuleDef(String name)

ModuleDef

public ModuleDef(String name,
                 ResourceLoader resources)

ModuleDef

public ModuleDef(String name,
                 ResourceLoader resources,
                 boolean monolithic,
                 boolean mergePathPrefixes)

Constructs a ModuleDef.

Method Detail

isValidModuleName

public static boolean isValidModuleName(String moduleName)

addDirectDependency

public void addDirectDependency(String currentModuleName,
                                String dependencyModuleName)

Register a dependencyModuleName as a directDependency of currentModuleName

addEntryPointTypeName

public void addEntryPointTypeName(String typeName)

addFileset

public void addFileset(String filesetModuleName)

Registers a module as a fileset.

addGwtXmlFile

public void addGwtXmlFile(File xmlFile)

addLinker

public void addLinker(String name)

addPublicPackage

public void addPublicPackage(String publicPackage,
                             String[] includeList,
                             String[] excludeList,
                             String[] skipList,
                             boolean defaultExcludes,
                             boolean caseSensitive)

addResourcePath

public void addResourcePath(String resourcePath)

addRule

public void addRule(Rule rule)

addSourcePackage

public void addSourcePackage(String sourcePackage,
                             String[] includeList,
                             String[] excludeList,
                             String[] skipList,
                             boolean defaultExcludes,
                             boolean caseSensitive)

addSourcePackageImpl

public void addSourcePackageImpl(String sourcePackage,
                                 String[] includeList,
                                 String[] excludeList,
                                 String[] skipList,
                                 boolean defaultExcludes,
                                 boolean caseSensitive,
                                 boolean isSuperSource)

addSuperSourcePackage

public void addSuperSourcePackage(String superSourcePackage,
                                  String[] includeList,
                                  String[] excludeList,
                                  String[] skipList,
                                  boolean defaultExcludes,
                                  boolean caseSensitive)

clear

public void clear()

Free up memory no longer needed in later compile stages. After calling this method, the ResourceOracle will be empty and unusable. Calling ensureResourcesScanned() will restore them.

clearEntryPoints

public void clearEntryPoints()

deactivateLinker

public boolean deactivateLinker(String linkerName)

Deactivate a linker by name. Returns false if the linker was not active, true otherwise.

defineLinker

public void defineLinker(TreeLogger logger,
                         String name,
                         Class<? extends Linker> linker)
                  throws UnableToCompleteException

Associate a Linker class with a symbolic name. If the name had been previously assigned, this method will redefine the name. If the redefined linker had been previously added to the set of active linkers, the old active linker will be replaced with the new linker.

Throws:

UnableToCompleteException

enterModule

public void enterModule(ModuleDef.ModuleType moduleType,
                        String canonicalModuleName)

Called as module tree parsing enters and exits individual module file of various types and so provides the ModuleDef with an opportunity to keep track of what context it is currently operating.
At the moment the ModuleDef uses it's monolithic property in combination with the entering modules ModuleType to updates its idea of attribute source.

exitModule

public void exitModule()

findPublicFile

public Resource findPublicFile(String partialPath)

findServletForPath

public String findServletForPath(String actual)

findSourceFile

public Resource findSourceFile(String partialPath)

Returns the Resource for a source file if it is found; null otherwise.

Parameters:

partialPath - the partial path of the source file

Returns:

the resource for the requested source file

getActiveLinkerNames

public Set<String> getActiveLinkerNames()

getActiveLinkers

public Set<Class<? extends Linker>> getActiveLinkers()

getActivePrimaryLinker

public Class<? extends Linker> getActivePrimaryLinker()

getAllCompilationUnitArchiveURLs

public Collection<URL> getAllCompilationUnitArchiveURLs()

Returns URLs to fetch archives of precompiled compilation units.

See Also:

CompileModule

getAllSourceFiles

public String[] getAllSourceFiles()

Strictly for statistics gathering. There is no guarantee that the source oracle has been initialized.

getBuildResourceOracle

public ResourceOracle getBuildResourceOracle()

getCanonicalName

public String getCanonicalName()

Returns the physical name for the module by which it can be found in the classpath.

getCompilationState

public CompilationState getCompilationState(TreeLogger logger,
                                            CompilerContext compilerContext)
                                     throws UnableToCompleteException

Throws:

UnableToCompleteException

getDirectDependencies

public Collection<String> getDirectDependencies(String libraryModuleName)

The module names for its direct non fileset dependents.

getEntryPointTypeNames

public String[] getEntryPointTypeNames()

getExternalLibraryCanonicalModuleNames

public Set<String> getExternalLibraryCanonicalModuleNames()

Returns the names of free-standing compilable library modules that are depended upon by this module.

getFileSetPathBetween

public List<String> getFileSetPathBetween(String fromModuleName,
                                          String toModuleName)

getFunctionName

public String getFunctionName()

getGeneratorRules

public List<Rule> getGeneratorRules()

getGwtXmlFilePath

public String getGwtXmlFilePath(String moduleName)

Description copied from interface: DepsInfoProvider

Returns the .gwt.xml file path for the given module referenced by name.

Specified by:

getGwtXmlFilePath in interface DepsInfoProvider

getInputFilenameHash

public int getInputFilenameHash()

Calculates a hash of the filenames of all the input files for the GWT compiler.

This is needed because the list of files could change without affecting the timestamp. For example, consider a glob that matches fewer files than before because a file was deleted.

getLinker

public Class<? extends Linker> getLinker(String name)

getLinkers

public Map<String,Class<? extends Linker>> getLinkers()

getName

public String getName()

getProperties

public Properties getProperties()

The properties that have been defined.

getPublicResourceOracle

public ResourceOracleImpl getPublicResourceOracle()

getResourceLastModified

public long getResourceLastModified()

getResourcesNewerThan

public Set<Resource> getResourcesNewerThan(long modificationTime)

getRules

public Rules getRules()

Gets a reference to the internal rules for this module def.

getScripts

public Scripts getScripts()

Gets a reference to the internal scripts list for this module def.

getServletPaths

public String[] getServletPaths()

getSourceModuleNames

public Set<String> getSourceModuleNames(String typeSourceName)

Description copied from interface: DepsInfoProvider

Returns a set of the names of modules that source included the given type referenced by name.

Specified by:

getSourceModuleNames in interface DepsInfoProvider

getSourceResourceOracle

public ResourceOracle getSourceResourceOracle()

getStyles

public Styles getStyles()

Gets a reference to the internal styles list for this module def.

getTargetLibraryCanonicalModuleNames

public Set<String> getTargetLibraryCanonicalModuleNames()

Returns the names of non-independently-compilable modules (mostly filesets) that together make up the current module.

getTransitiveDepModuleNames

public Set<String> getTransitiveDepModuleNames(String libraryModuleName)

Description copied from interface: DepsInfoProvider

Returns a set of the names of modules in the transitive dependency tree for the given module referenced by name.

Specified by:

getTransitiveDepModuleNames in interface DepsInfoProvider

isGwtXmlFileStale

public boolean isGwtXmlFileStale()

isInherited

public boolean isInherited(String moduleName)

lastModified

public long lastModified()

mapServlet

public void mapServlet(String path,
                       String servletClassName)

For convenience in unit tests, servlets can be automatically loaded and mapped in the embedded web server. If a servlet is already mapped to the specified path, it is replaced.

Parameters:

path - the url path at which the servlet resides

servletClassName - the name of the servlet to publish

printOverlappingSourceWarnings

public void printOverlappingSourceWarnings(TreeLogger logger)

recordModuleGwtXmlFile

public void recordModuleGwtXmlFile(String moduleName,
                                   String fileSourcePath)

refresh

public void refresh()

setCollapseAllProperties

public void setCollapseAllProperties(boolean collapse)

Mainly for testing and decreasing compile times.

setNameOverride

public void setNameOverride(String nameOverride)

Override the module's apparent name. Setting this value to nullwill disable the name override.