Package org.apache.struts.tiles.xmlDefinition

Class DefinitionsFactory

java.lang.Object

org.apache.struts.tiles.xmlDefinition.DefinitionsFactory

All Implemented Interfaces:

Serializable

public class DefinitionsFactory
extends Object
implements Serializable

A factory for definitions. This factory allows to retrieve definitions by their keys.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<String,ComponentDefinition>	definitions	Underlying map containing all definitions.

Constructor Summary

Constructors

Constructor	Description
DefinitionsFactory(XmlDefinitionsSet xmlDefinitions)	Constructor.

Method Summary

Modifier and Type	Method	Description
ComponentDefinition	getDefinition(String name, ServletRequest request, ServletContext servletContext)	Get a definition by its name.
void	putDefinition(ComponentDefinition definition)	Put definition in set.
String	toString()	Return String representation.

Methods inherited from class java.lang.Object

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

Field Details

definitions

protected HashMap<String,ComponentDefinition> definitions

Underlying map containing all definitions.

Constructor Details

DefinitionsFactory

public DefinitionsFactory(XmlDefinitionsSet xmlDefinitions)
                   throws NoSuchDefinitionException

Constructor. Create a factory initialized with definitions from XmlDefinitionsSet.

Parameters:

xmlDefinitions - Resolved definition from XmlDefinitionSet.

Throws:

NoSuchDefinitionException - If an error occurs while resolving inheritance

Method Details

getDefinition

public ComponentDefinition getDefinition(String name,
 ServletRequest request,
 ServletContext servletContext)
                                  throws NoSuchDefinitionException,
DefinitionsFactoryException

Get a definition by its name.

Parameters:

name - Name of the definition.

request - Servlet request.

servletContext - Servlet context.

Throws:

DefinitionsFactoryException - An error occur while getting definition.

NoSuchDefinitionException - No definition found for specified name Implementation can throw more accurate exception as a subclass of this exception.

putDefinition

public void putDefinition(ComponentDefinition definition)

Put definition in set.

Parameters:

definition - Definition to put.

toString

public String toString()

Return String representation.

Overrides:

toString in class Object

Returns:

String representation.