com.google.gwt.dev.cfg

Class ModuleDefLoader

java.lang.Object

com.google.gwt.dev.cfg.ModuleDefLoader

public class ModuleDefLoader
extends Object

The top-level API for loading module XML.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPILATION_UNIT_ARCHIVE_SUFFIX Filename suffix used for Precompiled GWT Module files.
static String	GWT_MODULE_XML_SUFFIX Filename suffix used for GWT Module XML files.

Method Summary

Modifier and Type	Method and Description
static void	clearModuleCache()
static ModuleDef	createSyntheticModule(TreeLogger logger, CompilerContext compilerContext, String moduleName, String[] inherits, boolean refresh) Creates a module in memory that is not associated with a .gwt.xml file on disk.
boolean	enforceStrictResources()
protected void	load(TreeLogger logger, String nameOfModuleToLoad, ModuleDef dest) Loads a module and all its included modules, recursively, into the given ModuleDef.
static ModuleDef	loadFromClassPath(TreeLogger logger, CompilerContext compilerContext, String moduleName) Loads a new (assumed monolithic) module from the class path and defers scanning associated directories for resources.
static ModuleDef	loadFromClassPath(TreeLogger logger, CompilerContext compilerContext, String moduleName, boolean refresh, boolean monolithic) Loads a new module from the class path and may or may not immediately scan associated directories for resources or consider it monolithic, depending on parameters.
static ModuleDef	loadFromClassPath(TreeLogger logger, String moduleName, boolean refresh) Deprecated.
static ModuleDef	loadFromResources(TreeLogger logger, CompilerContext compilerContext, String moduleName, ResourceLoader resources, boolean refresh, boolean monolithic) Loads a new module from the given ResourceLoader and may or may not immediately scan associated directories for resources or consider it monolithic, depending on parameters.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Field Detail

COMPILATION_UNIT_ARCHIVE_SUFFIX

public static final String COMPILATION_UNIT_ARCHIVE_SUFFIX

Filename suffix used for Precompiled GWT Module files.

See Also:

Constant Field Values

GWT_MODULE_XML_SUFFIX

public static final String GWT_MODULE_XML_SUFFIX

Filename suffix used for GWT Module XML files.

See Also:

Constant Field Values

Method Detail

clearModuleCache

public static void clearModuleCache()

createSyntheticModule

public static ModuleDef createSyntheticModule(TreeLogger logger,
                                              CompilerContext compilerContext,
                                              String moduleName,
                                              String[] inherits,
                                              boolean refresh)
                                       throws UnableToCompleteException

Creates a module in memory that is not associated with a .gwt.xml file on disk.

Parameters:

logger - logs the process

compilerContext - shared read only compiler state

moduleName - the synthetic module to create

inherits - a set of modules to inherit from

refresh - whether to refresh the module

Returns:

the loaded module

Throws:

UnableToCompleteException

loadFromClassPath

public static ModuleDef loadFromClassPath(TreeLogger logger,
                                          CompilerContext compilerContext,
                                          String moduleName)
                                   throws UnableToCompleteException

Loads a new (assumed monolithic) module from the class path and defers scanning associated directories for resources.

Throws:

UnableToCompleteException

loadFromClassPath

@Deprecated
public static ModuleDef loadFromClassPath(TreeLogger logger,
                                                      String moduleName,
                                                      boolean refresh)
                                               throws UnableToCompleteException

Deprecated.

Loads a new (assumed monolithic) module from the class path and may or may not immediately scan associated directories for resources.
Provided for Designer compatibility. Do not use.

Throws:

UnableToCompleteException

loadFromClassPath

public static ModuleDef loadFromClassPath(TreeLogger logger,
                                          CompilerContext compilerContext,
                                          String moduleName,
                                          boolean refresh,
                                          boolean monolithic)
                                   throws UnableToCompleteException

Loads a new module from the class path and may or may not immediately scan associated directories for resources or consider it monolithic, depending on parameters.

Throws:

UnableToCompleteException

loadFromResources

public static ModuleDef loadFromResources(TreeLogger logger,
                                          CompilerContext compilerContext,
                                          String moduleName,
                                          ResourceLoader resources,
                                          boolean refresh,
                                          boolean monolithic)
                                   throws UnableToCompleteException

Loads a new module from the given ResourceLoader and may or may not immediately scan associated directories for resources or consider it monolithic, depending on parameters.

Throws:

UnableToCompleteException

enforceStrictResources

public boolean enforceStrictResources()

load

protected void load(TreeLogger logger,
                    String nameOfModuleToLoad,
                    ModuleDef dest)
             throws UnableToCompleteException

Loads a module and all its included modules, recursively, into the given ModuleDef.

Throws:

UnableToCompleteException