since: 2.1.0 -

since: 2.1.0 -

since: 2.1.0 -

 public DigesterDefinitionsReader() 
{
        digester = new Digester();
        digester.setValidating(validating);
        digester.setNamespaceAware(true);
        digester.setUseContextClassLoader(true);
        digester.setErrorHandler(new ThrowingErrorHandler());
        // Register our local copy of the DTDs that we can find
        String[] registrations = getRegistrations();
        for (int i = 0; i <  registrations.length; i += 2) {
            URL url = this.getClass().getResource(
                registrations[i + 1]);
            if (url != null) {
                digester.register(registrations[i], url.toString());
            }
        }
        initSyntax(digester);
}

Creates a new instance of DigesterDefinitionsReader.

 public  void addDefinition(Definition definition) 
{
        String name = definition.getName();
        if (name == null) {
            throw new DigesterDefinitionsReaderException(
                    "A root definition has been defined with no name");
        }
        definitions.put(name, definition);
}

Adds a new Definition to the internal Map or replaces an existing one.

 protected String getNextUniqueDefinitionName(Map<String, Definition> definitions) 
{
        String candidate;
        do {
            candidate = "$anonymousDefinition" + anonymousDefinitionIndex;
            anonymousDefinitionIndex++;
        } while (definitions.containsKey(candidate));
        return candidate;
}

Create a unique definition name usable to store anonymous definitions.

 protected String[] getRegistrations() 
{
        if (registrations == null) {
            registrations = new String[] {
                "-//Apache Software Foundation//DTD Tiles Configuration 2.0//EN",
                "/org/apache/tiles/resources/tiles-config_2_0.dtd",
                "-//Apache Software Foundation//DTD Tiles Configuration 2.1//EN",
                "/org/apache/tiles/resources/tiles-config_2_1.dtd"};
        }
        return registrations;
}

Returns the registrations for local DTDs.

 public  void init(Map<String, String> params) 
{
        if (params != null) {
            String value = params.get(PARSER_VALIDATE_PARAMETER_NAME);
            if (value != null) {
                digester.setValidating(Boolean.valueOf(value));
            }
        }
}

Initializes the DefinitionsReader object.

This method must be called before the #read method is called.

 protected  void initSyntax(Digester digester) 
{
        initDigesterForTilesDefinitionsSyntax(digester);
}

Initialised the syntax for reading XML files containing Tiles definitions.

 public Map<String, Definition> read(Object source) 
{
        // This is an instance variable instead of a local variable because
        // we want to be able to call the addDefinition method to populate it.
        // But we reset the Map here, which, of course, has threading implications.
        definitions = new LinkedHashMap< String, Definition >();
        if (source == null) {
            // Perhaps we should throw an exception here.
            return null;
        }
        InputStream input;
        try {
            input = (InputStream) source;
        } catch (ClassCastException e) {
            throw new DefinitionsFactoryException(
                "Invalid source type.  Requires java.io.InputStream.", e);
        }
        try {
            // set first object in stack
            //digester.clear();
            digester.push(this);
            // parse
            digester.parse(input);
        } catch (SAXException e) {
            throw new DefinitionsFactoryException(
                "XML error reading definitions.", e);
        } catch (IOException e) {
            throw new DefinitionsFactoryException(
                "I/O Error reading definitions.", e);
        } finally {
            digester.clear();
        }
        return definitions;
}

Reads Definition objects from a source.

Implementations should publish what type of source object is expected.