|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.wst.server.core.model.ModuleFactoryDelegate
public abstract class ModuleFactoryDelegate
A module factory delegate provides a mechanism for discovering
modules. A module factory delegate is specified by the
class
attribute of a moduleFactories
extension.
When the module factory needs to be given a delegate, the delegate class specified for the module factory is instantiated with a 0-argument constructor.
Module factory delegates may keep state in instance fields, but that state is transient and will not be persisted across workbench sessions.
This abstract class is intended to be extended only by clients
to extend the moduleFactories
extension point.
IModule
,
ModuleDelegate
Constructor Summary | |
---|---|
ModuleFactoryDelegate()
Delegates must have a public 0-arg constructor. |
Method Summary | |
---|---|
void |
clearModuleCache()
Deprecated. This method is implementation specific and never called by the framework. It shouldn't be part of the public API, but subclasses are still welcome to provide their own method to clear the cache. |
IModule |
findModule(java.lang.String id)
Returns the module created by this factory that has the given id, or null if there is no module with the given id. |
abstract ModuleDelegate |
getModuleDelegate(IModule module)
Creates the module delegate for a module with the given information. |
abstract IModule[] |
getModules()
Return all modules created by this factory. |
IModule[] |
getModules(org.eclipse.core.resources.IProject project)
Return all modules created by this factory that are contained within the given project. |
void |
initialize()
Initializes this module factory delegate. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ModuleFactoryDelegate()
Method Detail |
---|
public void initialize()
This method is called by the server core framework. Clients should never call this method.
public void clearModuleCache()
getModules()
public abstract ModuleDelegate getModuleDelegate(IModule module)
module
- a module
public abstract IModule[] getModules()
This method is normally called by the web server core framework. Clients (other than the delegate) should never call this method.
A new array is returned on each call, so clients may store or modify the result.
IModule
public IModule[] getModules(org.eclipse.core.resources.IProject project)
This method is normally called by the web server core framework. Clients (other than the delegate) should never call this method.
A new array is returned on each call, so clients may store or modify the result.
project
- a project
IModule
public IModule findModule(java.lang.String id)
null
if there is no module with the given id. The id must
not be null.
Subclasses should override this method if they do not need to search through the entire project list.
This method is normally called by the web server core framework. Clients (other than the delegate) should never call this method.
id
- a module id
null
if no module
could be found IModule
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |