public class SchemeRefPreprocessor extends Object implements DocumentElementPreprocessor.ElementPreprocessor
SchemeRefPreprocessor
is an DocumentElementPreprocessor.ElementPreprocessor
that resolves declarations of <scheme-ref> as required by Coherence.Modifier and Type | Field and Description |
---|---|
static SchemeRefPreprocessor |
INSTANCE
This singleton instance of the
SchemeRefPreprocessor . |
Constructor and Description |
---|
SchemeRefPreprocessor() |
Modifier and Type | Method and Description |
---|---|
XmlElement |
findCachingScheme(String sSchemeName, XmlElement element)
Obtains the
XmlElement that contains a <scheme-name> definition for the specified sSchemeName with in the provided XmlElement , or null if not found. |
boolean |
preprocess(ProcessingContext context, XmlElement element)
Process an
XmlElement , optionally mutating it (or it's children) if required. |
public static final SchemeRefPreprocessor INSTANCE
SchemeRefPreprocessor
.public boolean preprocess(ProcessingContext context, XmlElement element) throws ConfigurationException
XmlElement
, optionally mutating it (or it's children) if required.
Note: An implementation of this interface should avoid attempting to traverse child XmlElement
s. If you wish to manually traverse or change the entire document, you should instead use a DocumentPreprocessor
.
preprocess
in interface DocumentElementPreprocessor.ElementPreprocessor
context
- the ProcessingContext
in which the pre-processing is occuringelement
- the XmlElement
to preprocesstrue
if the specified XmlElement
should be re-preprocessed by this and other DocumentElementPreprocessor.ElementPreprocessor
s due to the XmlElement
being modified, false
otherwise.ConfigurationException
- if during pre-processing of the XmlElement
a configuration issue was discovered (or if pre-processing fails for some reason)public XmlElement findCachingScheme(String sSchemeName, XmlElement element)
XmlElement
that contains a <scheme-name> definition for the specified sSchemeName with in the provided XmlElement
, or null
if not found.sSchemeName
- The scheme name to locateelement
- The XmlElement
to search