Class ComponentDefinitionsFactoryWrapper
java.lang.Object
org.apache.struts.tiles.definition.ComponentDefinitionsFactoryWrapper
- All Implemented Interfaces:
Serializable
,DefinitionsFactory
@Deprecated
public class ComponentDefinitionsFactoryWrapper
extends Object
implements DefinitionsFactory
Deprecated.
Use DefinitionsFactory instead.
Wrapper from new definition factory interface to old interface.
This class provides mapping from the old interface's life cycle to the new life cycle.
- Since:
- 20020708
- See Also:
-
Constructor Summary
ConstructorDescriptionDeprecated.Constructor.Deprecated.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Create map of configuration attributes from configuration object.protected ComponentDefinitionsFactory
createFactoryInstance
(String classname) Deprecated.Create Definition factory from provided classname which must implementComponentDefinitionsFactory
.void
destroy()
Deprecated.Do nothing because old life cycle has no equivalent.Deprecated.Get underlying factory configuration.getDefinition
(String name, ServletRequest request, ServletContext servletContext) Deprecated.Get requested definition.Deprecated.Get internal factory.void
init
(DefinitionsFactoryConfig config, ServletContext servletContext) Deprecated.Call underlying factory init method.void
setConfig
(DefinitionsFactoryConfig config, ServletContext servletContext) Deprecated.Set underlying factory configuration.toString()
Deprecated.Return String representation.
-
Constructor Details
-
ComponentDefinitionsFactoryWrapper
Deprecated.Constructor. Create new wrapper for specified factory.- Parameters:
factory
- The factory to create a wrapper for.
-
ComponentDefinitionsFactoryWrapper
public ComponentDefinitionsFactoryWrapper()Deprecated.Constructor. Create new wrapper. The config object passed to init method should reference a factory implementingComponentDefinitionsFactory
.
-
-
Method Details
-
getDefinition
public ComponentDefinition getDefinition(String name, ServletRequest request, ServletContext servletContext) throws NoSuchDefinitionException, DefinitionsFactoryException Deprecated.Get requested definition.- Specified by:
getDefinition
in interfaceDefinitionsFactory
- Parameters:
name
- Name of the definition.request
- The request we are processing.servletContext
- Our servlet context.- Returns:
- ComponentDefition
- Throws:
NoSuchDefinitionException
- No definition found for specified name Implementation can throw more accurate exception as a subclass of this exceptionDefinitionsFactoryException
- An error occur while getting definition.
-
init
public void init(DefinitionsFactoryConfig config, ServletContext servletContext) throws DefinitionsFactoryException Deprecated.Call underlying factory init method.- Specified by:
init
in interfaceDefinitionsFactory
- Parameters:
config
- DefinitionsFactoryConfig.servletContext
- Our servlet context.- Throws:
DefinitionsFactoryException
- An error occur during initialization.
-
destroy
public void destroy()Deprecated.Do nothing because old life cycle has no equivalent.- Specified by:
destroy
in interfaceDefinitionsFactory
-
setConfig
public void setConfig(DefinitionsFactoryConfig config, ServletContext servletContext) throws DefinitionsFactoryException Deprecated.Set underlying factory configuration.- Specified by:
setConfig
in interfaceDefinitionsFactory
- Parameters:
config
- DefinitionsFactoryConfig to use.servletContext
- Our servlet context.- Throws:
DefinitionsFactoryException
- An error occur during initialization.
-
getConfig
Deprecated.Get underlying factory configuration.- Specified by:
getConfig
in interfaceDefinitionsFactory
- Returns:
- DefinitionsFactoryConfig.
-
getInternalFactory
Deprecated.Get internal factory.- Returns:
- The internal ComponentDefitionsFactory.
-
createFactoryInstance
protected ComponentDefinitionsFactory createFactoryInstance(String classname) throws DefinitionsFactoryException Deprecated.Create Definition factory from provided classname which must implementComponentDefinitionsFactory
. Factory class must extendDefinitionsFactory
.- Parameters:
classname
- Class name of the factory to create.- Returns:
- newly created factory.
- Throws:
DefinitionsFactoryException
- If an error occur while initializing factory
-
toString
Deprecated.Return String representation. Calls toString() on underlying factory. -
createConfigMap
Deprecated.Create map of configuration attributes from configuration object. Mapping is done between old names and new names.- Parameters:
config
- The DefinitionsFactoryConfig to use.- Returns:
- Map Map of name/value pairs.
-