This project has retired. For details please refer to its Attic page.

org.apache.tiles.factory
Class KeyedDefinitionsFactoryTilesContainerFactory

java.lang.Object
  org.apache.tiles.factory.TilesContainerFactory
      org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory

public class KeyedDefinitionsFactoryTilesContainerFactory
extends TilesContainerFactory

Factory that creates instances of container that will extend the KeyedDefinitionsFactoryTilesContainer class.

Version:

$Rev: 680124 $ $Date: 2008-07-27 17:20:00 +0200 (Sun, 27 Jul 2008) $

Field Summary

static String	CONTAINER_KEYS_INIT_PARAM The name of the initialization parameter that will contain a comma-separated list of keys to use.
static String	KEY_EXTRACTOR_CLASS_INIT_PARAM Init parameter name that contains the class name for the key extractor.

Fields inherited from class org.apache.tiles.factory.TilesContainerFactory

CONTAINER_FACTORY_INIT_PARAM, CONTAINER_FACTORY_MUTABLE_INIT_PARAM, CONTEXT_FACTORY_INIT_PARAM, defaultConfiguration, DEFINITIONS_FACTORY_INIT_PARAM, PREPARER_FACTORY_INIT_PARAM

Constructor Summary

KeyedDefinitionsFactoryTilesContainerFactory()

Method Summary

DefinitionsFactory	createDefinitionsFactory(Object context) Creates a definitions factory.
MutableTilesContainer	createMutableTilesContainer(Object context) Creates a mutable Tiles container.
TilesContainer	createTilesContainer(Object context) Creates an immutable Tiles container.
protected void	storeContainerDependencies(Object context, Map<String,String> initParameters, Map<String,String> configuration, BasicTilesContainer container) Stores container dependencies, that is called before TilesContainer.init(Map).

Methods inherited from class org.apache.tiles.factory.TilesContainerFactory

createContainer, createFactory, getFactory, getFactory, getInitParameter, getInitParameterMap, initializeContainer, resolveFactoryName, setDefaultConfiguration, setDefaultValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTAINER_KEYS_INIT_PARAM

public static final String CONTAINER_KEYS_INIT_PARAM

The name of the initialization parameter that will contain a comma-separated list of keys to use.

See Also:

Constant Field Values

KEY_EXTRACTOR_CLASS_INIT_PARAM

public static final String KEY_EXTRACTOR_CLASS_INIT_PARAM

Init parameter name that contains the class name for the key extractor.

See Also:

Constant Field Values

Constructor Detail

KeyedDefinitionsFactoryTilesContainerFactory

public KeyedDefinitionsFactoryTilesContainerFactory()

Method Detail

createMutableTilesContainer

public MutableTilesContainer createMutableTilesContainer(Object context)
                                                  throws TilesException

Creates a mutable Tiles container.

Overrides:

createMutableTilesContainer in class TilesContainerFactory

Parameters:

context - The (application) context object.

Returns:

The created Tiles container.

Throws:

TilesException - If something goes wrong during initialization.

createTilesContainer

public TilesContainer createTilesContainer(Object context)
                                    throws TilesException

Creates an immutable Tiles container.

Overrides:

createTilesContainer in class TilesContainerFactory

Parameters:

context - The (application) context object.

Returns:

The created Tiles container.

Throws:

TilesException - If something goes wrong during initialization.

createDefinitionsFactory

public DefinitionsFactory createDefinitionsFactory(Object context)
                                            throws TilesException

Creates a definitions factory.

Parameters:

context - The context object to use.

Returns:

The newly created definitions factory.

Throws:

TilesException - If something goes wrong.

storeContainerDependencies

protected void storeContainerDependencies(Object context,
                                          Map<String,String> initParameters,
                                          Map<String,String> configuration,
                                          BasicTilesContainer container)
                                   throws TilesException

Stores container dependencies, that is called before TilesContainer.init(Map).

Overrides:

storeContainerDependencies in class TilesContainerFactory

Parameters:

context - The (application) context object to use.

initParameters - The initialization parameters.

configuration - The merged configuration parameters (both defaults and context ones).

container - The container to use.

Throws:

TilesException - If something goes wrong during initialization.