Package com.tangosol.coherence.config.xml.preprocessor

Class ExtendPreprocessor

java.lang.Object

com.tangosol.coherence.config.xml.preprocessor.ExtendPreprocessor

All Implemented Interfaces:

DocumentElementPreprocessor.ElementPreprocessor

public class ExtendPreprocessor
extends Object
implements DocumentElementPreprocessor.ElementPreprocessor

An ExtendPreprocessor is an DocumentElementPreprocessor.ElementPreprocessor that will inject an "acceptor-config" XmlElement into a "proxy-scheme" XmlElement if one does not exist.

Since:

Coherence 12.1.3

Author:

lh 2013.07.09

Field Summary

Fields

Modifier and Type	Field	Description
static final ExtendPreprocessor	INSTANCE	This singleton instance of the ExtendPreprocessor.

Constructor Summary

Constructors

Constructor	Description
ExtendPreprocessor()

Method Summary

Modifier and Type	Method	Description
boolean	preprocess(ProcessingContext context, XmlElement element)	Process an XmlElement, optionally mutating it (or it's children) if required.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final ExtendPreprocessor INSTANCE

This singleton instance of the ExtendPreprocessor.

Constructor Details

ExtendPreprocessor

public ExtendPreprocessor()

Method Details

preprocess

public boolean preprocess(ProcessingContext context,
 XmlElement element)
                   throws ConfigurationException

Process an XmlElement, optionally mutating it (or it's children) if required.

Note: An implementation of this interface should avoid attempting to traverse child XmlElements. If you wish to manually traverse or change the entire document, you should instead use a DocumentPreprocessor.

Specified by:

preprocess in interface DocumentElementPreprocessor.ElementPreprocessor

Parameters:

context - the ProcessingContext in which the pre-processing is occurring

element - the XmlElement to preprocess

Returns:

true if the specified XmlElement should be re-preprocessed by this and other DocumentElementPreprocessor.ElementPreprocessors due to the XmlElement being modified, false otherwise.

Throws:

ConfigurationException - if during pre-processing of the XmlElement a configuration issue was discovered (or if pre-processing fails for some reason)