com.tangosol.coherence.config.xml.processor

Class AbstractEmptyElementProcessor<T>

java.lang.Object

com.tangosol.coherence.config.xml.processor.AbstractEmptyElementProcessor<T>

All Implemented Interfaces:

ConditionalElementProcessor<T>, ElementProcessor<T>

Direct Known Subclasses:

EnumProcessor, MemberListenerProcessor, MemorySizeProcessor, MillisProcessor, PartitionListenerProcessor, PasswordProviderBuilderProcessor, PersistenceEnvironmentsProcessor.PersistenceEnvironmentProcessor, PersistenceProcessor, SerializerBuilderProcessor, SerializerFactoryProcessor, ServiceFailurePolicyProcessor, SpecificInstanceProcessor, StorageAccessAuthorizerBuilderProcessor

public abstract class AbstractEmptyElementProcessor<T>
extends Object
implements ConditionalElementProcessor<T>

A ConditionalElementProcessor that provides defined behaviors for processing empty XmlElements.

Since:

Coherence 12.1.3

Author:

bo 2013.09.15

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractEmptyElementProcessor.EmptyElementBehavior The behavior of the ConditionalElementProcessor when it encounters an empty XmlElement.

Constructor Summary

Constructors

Constructor and Description
AbstractEmptyElementProcessor() Constructs an AbstractEmptyElementProcessor that will attempt to process empty XmlElements.
AbstractEmptyElementProcessor(AbstractEmptyElementProcessor.EmptyElementBehavior behavior) Constructs an AbstractEmptyElementProcessor with the specified behavior for processing empty XmlElements (with a default value of null).
AbstractEmptyElementProcessor(T oDefaultValue) Constructs an AbstractEmptyElementProcessor that will return the specified default value when it encounters an empty XmlElement.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(ProcessingContext context, XmlElement xmlElement) Determines if the specified XmlElement should be processed.
protected boolean	isEmptyElement(ProcessingContext context, XmlElement xmlElement) Determines if an XmlElement is considered empty.
protected abstract T	onProcess(ProcessingContext context, XmlElement xmlElement) Process an XmlElement to return a specific type of value.
T	process(ProcessingContext context, XmlElement xmlElement) Process an XmlElement to return a specific type of value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEmptyElementProcessor

public AbstractEmptyElementProcessor()

Constructs an AbstractEmptyElementProcessor that will attempt to process empty XmlElements.

AbstractEmptyElementProcessor

public AbstractEmptyElementProcessor(AbstractEmptyElementProcessor.EmptyElementBehavior behavior)

Constructs an AbstractEmptyElementProcessor with the specified behavior for processing empty XmlElements (with a default value of null).

Parameters:

behavior - the required AbstractEmptyElementProcessor.EmptyElementBehavior

AbstractEmptyElementProcessor

public AbstractEmptyElementProcessor(T oDefaultValue)

Constructs an AbstractEmptyElementProcessor that will return the specified default value when it encounters an empty XmlElement.

Parameters:

oDefaultValue - the default value to return

Method Detail

onProcess

protected abstract T onProcess(ProcessingContext context,
                               XmlElement xmlElement)
                        throws ConfigurationException

Process an XmlElement to return a specific type of value.

Parameters:

context - the ProcessingContext in which the XmlElement is being processed

xmlElement - the XmlElement to process

Returns:

a value of type T

Throws:

ConfigurationException - when a configuration problem was encountered

isEmptyElement

protected boolean isEmptyElement(ProcessingContext context,
                                 XmlElement xmlElement)

Determines if an XmlElement is considered empty.

Parameters:

context - the ProcessingContext in which the XmlElement is being processed

xmlElement - the XmlElement to process

Returns:

true if the XmlElement is considered empty

accepts

public boolean accepts(ProcessingContext context,
                       XmlElement xmlElement)
                throws ConfigurationException

Determines if the specified XmlElement should be processed.

Specified by:

accepts in interface ConditionalElementProcessor<T>

Parameters:

context - the ProcessingContext in which the XmlElement is being processed

xmlElement - the XmlElement that would be processed

Returns:

true if the XmlElement should be processed

Throws:

ConfigurationException - when a configuration problem was encountered

process

public final T process(ProcessingContext context,
                       XmlElement xmlElement)
                throws ConfigurationException

Process an XmlElement to return a specific type of value.

Specified by:

process in interface ElementProcessor<T>

Parameters:

context - the ProcessingContext in which the XmlElement is being processed

xmlElement - the XmlElement to process

Returns:

a value of type T

Throws:

ConfigurationException - when a configuration problem was encountered