com.google.gwt.dev.cfg

Class ModuleDef

java.lang.Object

com.google.gwt.dev.cfg.ModuleDef

public class ModuleDef
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
ModuleDef(String name)
ModuleDef(String name, ResourceLoader resources)
ModuleDef(String name, ResourceLoader resources, boolean monolithic)

Method Summary

Modifier and Type	Method and Description
void	addEntryPointTypeName(String typeName)
void	addGwtXmlFile(File xmlFile)
void	addLinker(String name)
void	addPublicPackage(String publicPackage, String[] includeList, String[] excludeList, String[] skipList, boolean defaultExcludes, boolean caseSensitive)
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()
void	defineLinker(TreeLogger logger, String name, Class<? extends Linker> linker) Associate a Linker class with a symbolic name.
void	enterModule(ModuleDef.ModuleType moduleType) 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[]	getAllPublicFiles()
String[]	getAllSourceFiles() Strictly for statistics gathering.
String	getCanonicalName() Returns the physical name for the module by which it can be found in the classpath.
CompilationState	getCompilationState(TreeLogger logger) Deprecated.
CompilationState	getCompilationState(TreeLogger logger, CompilerContext compilerContext)
String[]	getEntryPointTypeNames()
String	getFunctionName()
Class<? extends Linker>	getLinker(String name)
Map<String,Class<? extends Linker>>	getLinkers()
String	getName()
Properties	getProperties() The properties that have been defined.
ResourceOracle	getResourcesOracle()
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()
Styles	getStyles() Gets a reference to the internal styles list for this module def.
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	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

Constructor Detail

ModuleDef

public ModuleDef(String name)

ModuleDef

public ModuleDef(String name,
                 ResourceLoader resources)

ModuleDef

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

Method Detail

isValidModuleName

public static boolean isValidModuleName(String moduleName)

addEntryPointTypeName

public void addEntryPointTypeName(String typeName)

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)

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 refresh() will restore them.

clearEntryPoints

public void clearEntryPoints()

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)

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

getAllPublicFiles

public String[] getAllPublicFiles()

getAllSourceFiles

public String[] getAllSourceFiles()

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

getCanonicalName

public String getCanonicalName()

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

getCompilationState

@Deprecated
public CompilationState getCompilationState(TreeLogger logger)
                                                 throws UnableToCompleteException

Deprecated.

Provided for Designer compatibility. Do not use.

Throws:

UnableToCompleteException

getCompilationState

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

Throws:

UnableToCompleteException

getEntryPointTypeNames

public String[] getEntryPointTypeNames()

getFunctionName

public String getFunctionName()

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.

getResourcesOracle

public ResourceOracle getResourcesOracle()

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()

getStyles

public Styles getStyles()

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

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

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 null will disable the name override.