org.apache.struts.tiles.definition

Class ComponentDefinitionsFactoryWrapper

public class ComponentDefinitionsFactoryWrapper extends 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
DefinitionsFactoryConfigconfig
Factory configuration,
ComponentDefinitionsFactoryfactory
The underlying factory.
Constructor Summary
ComponentDefinitionsFactoryWrapper(ComponentDefinitionsFactory factory)
Constructor.
ComponentDefinitionsFactoryWrapper()
Constructor.
Method Summary
static MapcreateConfigMap(DefinitionsFactoryConfig config)
Create map of configuration attributes from configuration object.
protected ComponentDefinitionsFactorycreateFactoryInstance(String classname)
Create Definition factory from provided classname which must implement {@link ComponentDefinitionsFactory}.
voiddestroy()
Do nothing because old life cycle has no equivalent.
DefinitionsFactoryConfiggetConfig()
Get underlying factory configuration.
ComponentDefinitiongetDefinition(String name, ServletRequest request, ServletContext servletContext)
Get requested definition.
ComponentDefinitionsFactorygetInternalFactory()
Get internal factory.
voidinit(DefinitionsFactoryConfig config, ServletContext servletContext)
Call underlying factory init method.
voidsetConfig(DefinitionsFactoryConfig config, ServletContext servletContext)
Set underlying factory configuration.
StringtoString()
Return String representation.

Field Detail

config

private DefinitionsFactoryConfig config
Factory configuration,

factory

private ComponentDefinitionsFactory factory
The underlying factory.

Constructor Detail

ComponentDefinitionsFactoryWrapper

public ComponentDefinitionsFactoryWrapper(ComponentDefinitionsFactory factory)
Constructor. Create new wrapper for specified factory.

Parameters: factory The factory to create a wrapper for.

ComponentDefinitionsFactoryWrapper

public ComponentDefinitionsFactoryWrapper()
Constructor. Create new wrapper. The config object passed to init method should reference a factory implementing {@link ComponentDefinitionsFactory}.

Method Detail

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)
Create Definition factory from provided classname which must implement {@link ComponentDefinitionsFactory}. Factory class must extend {@link 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.

getConfig

public DefinitionsFactoryConfig getConfig()
Get underlying factory configuration.

Returns: DefinitionsFactoryConfig.

getDefinition

public ComponentDefinition getDefinition(String name, ServletRequest request, ServletContext servletContext)
Get requested definition.

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)
Call underlying factory init method.

Parameters: config DefinitionsFactoryConfig. servletContext Our servlet context.

setConfig

public void setConfig(DefinitionsFactoryConfig config, ServletContext servletContext)
Set underlying factory configuration.

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