org.apache.struts.tiles.definition

Class ComponentDefinitionsFactoryWrapper

Implemented Interfaces:
DefinitionsFactory, Serializable

public class ComponentDefinitionsFactoryWrapper
extends java.lang.Object
implements DefinitionsFactory

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

Field Summary

private DefinitionsFactoryConfig
config
Factory configuration,
private ComponentDefinitionsFactory
factory
The underlying factory.

Constructor Summary

ComponentDefinitionsFactoryWrapper()
Constructor.
ComponentDefinitionsFactoryWrapper(ComponentDefinitionsFactory factory)
Constructor.

Method Summary

static Map
createConfigMap(DefinitionsFactoryConfig config)
Create map of configuration attributes from configuration object.
protected ComponentDefinitionsFactory
createFactoryInstance(String classname)
Create Definition factory from provided classname which must implement ComponentDefinitionsFactory.
void
destroy()
Do nothing because old life cycle has no equivalent.
DefinitionsFactoryConfig
getConfig()
Get underlying factory configuration.
ComponentDefinition
getDefinition(String name, ServletRequest request, ServletContext servletContext)
Get requested definition.
ComponentDefinitionsFactory
getInternalFactory()
Get internal factory.
void
init(DefinitionsFactoryConfig config, ServletContext servletContext)
Call underlying factory init method.
void
setConfig(DefinitionsFactoryConfig config, ServletContext servletContext)
Set underlying factory configuration.
String
toString()
Return String representation.

Field Details

config

private DefinitionsFactoryConfig config
Factory configuration,

factory

private ComponentDefinitionsFactory factory
The underlying factory.

Constructor Details

ComponentDefinitionsFactoryWrapper

public ComponentDefinitionsFactoryWrapper()

ComponentDefinitionsFactoryWrapper

public ComponentDefinitionsFactoryWrapper(ComponentDefinitionsFactory factory)
Constructor. Create new wrapper for specified factory.
Parameters:
factory - The factory to create a wrapper for.

Method Details

createConfigMap

public static Map createConfigMap(DefinitionsFactoryConfig config)
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.

createFactoryInstance

protected ComponentDefinitionsFactory createFactoryInstance(String classname)
            throws DefinitionsFactoryException
Create Definition factory from provided classname which must implement ComponentDefinitionsFactory. Factory class must extend DefinitionsFactory.
Parameters:
classname - Class name of the factory to create.
Returns:
newly created factory.
Throws:
DefinitionsFactoryException - If an error occur while initializing factory

destroy

public void destroy()
Do nothing because old life cycle has no equivalent.
Specified by:
destroy in interface DefinitionsFactory

getConfig

public DefinitionsFactoryConfig getConfig()
Get underlying factory configuration.
Specified by:
getConfig in interface DefinitionsFactory
Returns:
DefinitionsFactoryConfig.

getDefinition

public ComponentDefinition getDefinition(String name,
                                         ServletRequest request,
                                         ServletContext servletContext)
            throws NoSuchDefinitionException,
                   DefinitionsFactoryException
Get requested definition.
Specified by:
getDefinition in interface DefinitionsFactory
Parameters:
name - Name of the definition.
request - The request we are processing.
servletContext - Our servlet context.
Returns:
ComponentDefition

getInternalFactory

public ComponentDefinitionsFactory getInternalFactory()
Get internal factory.
Returns:
The internal ComponentDefitionsFactory.

init

public void init(DefinitionsFactoryConfig config,
                 ServletContext servletContext)
            throws DefinitionsFactoryException
Call underlying factory init method.
Specified by:
init in interface DefinitionsFactory
Parameters:
config - DefinitionsFactoryConfig.
servletContext - Our servlet context.

setConfig

public void setConfig(DefinitionsFactoryConfig config,
                      ServletContext servletContext)
            throws DefinitionsFactoryException
Set underlying factory configuration.
Specified by:
setConfig in interface DefinitionsFactory
Parameters:
config - DefinitionsFactoryConfig to use.
servletContext - Our servlet context.

toString

public String toString()
Return String representation. Calls toString() on underlying factory.
Returns:
String representation.

Copyright B) 2000-2007 - The Apache Software Foundation