org.eclipse.jst.jsf.core.jsfappconfig
Class AbstractJSFAppConfigLocater

java.lang.Object
  extended by org.eclipse.jst.jsf.core.jsfappconfig.AbstractJSFAppConfigLocater
All Implemented Interfaces:
IJSFAppConfigLocater
Direct Known Subclasses:
ImplicitRuntimeJSFAppConfigLocater, RuntimeClasspathJSFAppConfigLocater, WebContentRelativeJSFAppConfigLocater

public abstract class AbstractJSFAppConfigLocater
extends java.lang.Object
implements IJSFAppConfigLocater

Abstract implementation of IJSFAppConfigLocater that provides common locater functionality. IJSFAppConfigLocater implementations should extend this class or provide similar functionality.

Provisional API - subject to change


Constructor Summary
AbstractJSFAppConfigLocater()
           
 
Method Summary
 JSFAppConfigManager getJSFAppConfigManager()
          Gets the JSFAppConfigManager instance to which this locater belongs.
 java.util.Set getJSFAppConfigProviders()
          Gets the set of IJSFAppConfigProvider instances that this locater has located.
 void setJSFAppConfigManager(JSFAppConfigManager manager)
          Sets the JSFAppConfigManager instance to which this locater belongs.
abstract  void startLocating()
          Starts locating JSF application configuration resources.
abstract  void stopLocating()
          Stops locating JSF application configuration resources.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractJSFAppConfigLocater

public AbstractJSFAppConfigLocater()
Method Detail

setJSFAppConfigManager

public void setJSFAppConfigManager(JSFAppConfigManager manager)
Description copied from interface: IJSFAppConfigLocater
Sets the JSFAppConfigManager instance to which this locater belongs.

Specified by:
setJSFAppConfigManager in interface IJSFAppConfigLocater
Parameters:
manager - JSFAppConfigManager instance to be set.

getJSFAppConfigManager

public JSFAppConfigManager getJSFAppConfigManager()
Description copied from interface: IJSFAppConfigLocater
Gets the JSFAppConfigManager instance to which this locater belongs.

Specified by:
getJSFAppConfigManager in interface IJSFAppConfigLocater
Returns:
JSFAppConfigManager instance to which this locater belongs.

startLocating

public abstract void startLocating()
Description copied from interface: IJSFAppConfigLocater
Starts locating JSF application configuration resources.

Specified by:
startLocating in interface IJSFAppConfigLocater

stopLocating

public abstract void stopLocating()
Description copied from interface: IJSFAppConfigLocater
Stops locating JSF application configuration resources.

Specified by:
stopLocating in interface IJSFAppConfigLocater

getJSFAppConfigProviders

public java.util.Set getJSFAppConfigProviders()
Description copied from interface: IJSFAppConfigLocater
Gets the set of IJSFAppConfigProvider instances that this locater has located.

Specified by:
getJSFAppConfigProviders in interface IJSFAppConfigLocater
Returns:
set of IJSFAppConfigProvider instances.