public class DigesterDefinitionsReader extends Object implements DefinitionsReader
Definition objects from
 an XML InputStream using Digester. 
 
 This DefinitionsReader implementation expects the source to be
 passed as an InputStream. It parses XML data from the source
 and builds a Map of Definition objects.
 
 The Digester object can be configured by passing in initialization
 parameters. Currently the only parameter that is supported is the
 validating parameter. This value is set to false
 by default. To enable DTD validation for XML Definition files, give the init
 method a parameter with a key of
 org.apache.tiles.definition.digester.DigesterDefinitionsReader.PARSER_VALIDATE
 and a value of "true". 
 The Definition objects are stored internally in a Map. The Map is stored as
 an instance variable rather than a local variable in the read
 method. This means that instances of this class are not
 thread-safe and access by multiple threads must be synchronized.
 
| Modifier and Type | Field and Description | 
|---|---|
| protected static String | DEFINITION_HANDLER_CLASSThe handler to create definitions. | 
| protected Map<String,Definition> | definitionsStores Definition objects. | 
| protected org.apache.commons.digester3.Digester | digesterDigesterobject used to read Definition data
 from the source. | 
| protected static String | LIST_HANDLER_CLASSThe handler to create list attributes. | 
| protected static String | PUT_ATTRIBUTE_HANDLER_CLASSThe handler to create attributes. | 
| Constructor and Description | 
|---|
| DigesterDefinitionsReader()Creates a new instance of DigesterDefinitionsReader. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | addDefinition(Definition definition)Adds a new  Definitionto the internal Map or replaces
 an existing one. | 
| protected String[] | getRegistrations()Returns the registrations for local DTDs. | 
| protected void | initSyntax(org.apache.commons.digester3.Digester digester)Initialised the syntax for reading XML files containing Tiles
 definitions. | 
| Map<String,Definition> | read(Object source)Reads  objects from a source. | 
| void | setValidating(boolean validating)Sets the validation of XML files. | 
protected static final String DEFINITION_HANDLER_CLASS
protected static final String PUT_ATTRIBUTE_HANDLER_CLASS
protected static final String LIST_HANDLER_CLASS
protected final org.apache.commons.digester3.Digester digester
Digester object used to read Definition data
 from the source.protected Map<String,Definition> definitions
public DigesterDefinitionsReader()
public void setValidating(boolean validating)
validating - true means that XML validation is turned
                   on. false otherwise.public Map<String,Definition> read(Object source)
Definitionread in interface DefinitionsReadersource - The InputStream source from which definitions
               will be read.Definition objects read from
 the source.DefinitionsFactoryException - If the source is invalid or
                                     an error occurs when reading definitions.protected void initSyntax(org.apache.commons.digester3.Digester digester)
digester - The digester to initialize.public void addDefinition(Definition definition)
Definition to the internal Map or replaces
 an existing one.definition - The Definition object to be added.protected String[] getRegistrations()
Copyright © 2000–2025 Apache Software Foundation. All rights reserved.