Package com.tangosol.config.xml

Class DocumentProcessor

java.lang.Object

com.tangosol.config.xml.DocumentProcessor

public class DocumentProcessor
extends Object

A DocumentProcessor is responsible for processing in an XmlDocument to produce a resulting configured resource.

During the processing of the XmlDocument, the provided ResourceRegistry may be accessed/mutated.

Since:

Coherence 12.1.2

Author:

bo 2011.06.15

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentProcessor.DefaultDependencies	The DocumentProcessor.DefaultDependencies is the default implementation of the DocumentProcessor DocumentProcessor.Dependencies interface.
static interface	DocumentProcessor.Dependencies	The DocumentProcessor.Dependencies of DocumentProcessors.

Constructor Summary

Constructors

Constructor	Description
DocumentProcessor(DocumentProcessor.Dependencies dependencies)	Construct a DocumentProcessor.

Method Summary

Modifier and Type	Method	Description
<T> T	process(XmlDocumentReference refDocument, XmlDocumentReference... aOverrides)	Processes the XmlDocument located at the specified XmlDocumentReference.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentProcessor

public DocumentProcessor(DocumentProcessor.Dependencies dependencies)

Construct a DocumentProcessor.

Parameters:

dependencies - the DocumentProcessor.Dependencies for the DocumentProcessor

Method Detail

process

public <T> T process(XmlDocumentReference refDocument,
                     XmlDocumentReference... aOverrides)
              throws ConfigurationException

Processes the XmlDocument located at the specified XmlDocumentReference.

Type Parameters:

T - the resource type

Parameters:

refDocument - the XmlDocumentReference

aOverrides - reference overrides

Returns:

a configured resource based on processing the root element (and children when required) of the XmlDocument specified by the XmlDocumentReference

Throws:

ConfigurationException - when a configuration problem was encountered