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

org.apache.tiles.impl.mgmt
Class CachingTilesContainer

java.lang.Object
  org.apache.tiles.impl.BasicTilesContainer
      org.apache.tiles.impl.mgmt.CachingTilesContainer

All Implemented Interfaces:

MutableTilesContainer, TilesContainer

public class CachingTilesContainer
extends BasicTilesContainer
implements MutableTilesContainer

Mutable container which caches (in memory) the definitions registered to it. If a definition is not found in cache, it will revert back to it's definitions factory.

Since:

Tiles 2.0

Version:

$Rev: 537196 $ $Date: 2007-05-11 16:07:35 +0200 (Fri, 11 May 2007) $

Field Summary

Fields inherited from class org.apache.tiles.impl.BasicTilesContainer

DEFINITIONS_CONFIG

Constructor Summary

CachingTilesContainer()

Method Summary

protected Definition	getDefinition(String definition, TilesRequestContext context) Returns a definition specifying its name.
DefinitionsFactory	getDefinitionsFactory() Returns the definitions factory.
void	register(Definition definition, Object... requestItems) Register a new definition with the container.
protected void	register(Definition definition, TilesRequestContext request) Registers a custom definition.
void	setDefinitionsFactory(DefinitionsFactory definitionsFactory) Set the definitions factory.

Methods inherited from class org.apache.tiles.impl.BasicTilesContainer

checkInit, endContext, getApplicationContext, getAttributeContext, getContext, getContextFactory, getContextStack, getPreparerFactory, getResourceNames, getResourceString, getResourceString, init, initializeDefinitionsFactory, isValidDefinition, popContext, prepare, pushContext, render, render, setApplicationContext, setContextFactory, setPreparerFactory, startContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tiles.TilesContainer

endContext, getApplicationContext, getAttributeContext, init, isValidDefinition, prepare, render, render, startContext

Constructor Detail

CachingTilesContainer

public CachingTilesContainer()

Method Detail

register

public void register(Definition definition,
                     Object... requestItems)
              throws TilesException

Register a new definition with the container.

Specified by:

register in interface MutableTilesContainer

Parameters:

definition - The definition to register.

requestItems - the current request objects.

Throws:

TilesException - If something goes wrong during registration.

getDefinition

protected Definition getDefinition(String definition,
                                   TilesRequestContext context)
                            throws DefinitionsFactoryException

Returns a definition specifying its name.

Overrides:

getDefinition in class BasicTilesContainer

Parameters:

definition - The name of the definition to find.

context - The request context.

Returns:

The definition, if found.

Throws:

DefinitionsFactoryException - If the definitions factory throws an exception.

getDefinitionsFactory

public DefinitionsFactory getDefinitionsFactory()

Returns the definitions factory.

Overrides:

getDefinitionsFactory in class BasicTilesContainer

Returns:

The definitions factory used by this container.

setDefinitionsFactory

public void setDefinitionsFactory(DefinitionsFactory definitionsFactory)

Set the definitions factory. This method first ensures that the container has not yet been initialized.

Overrides:

setDefinitionsFactory in class BasicTilesContainer

Parameters:

definitionsFactory - the definitions factory for this instance.

register

protected void register(Definition definition,
                        TilesRequestContext request)
                 throws DefinitionsFactoryException

Registers a custom definition.

Parameters:

definition - The definition to register.

request - The request inside which the definition should be registered.

Throws:

DefinitionsFactoryException - If something goes wrong during adding a definition, such as missing parent definitions.