Package org.smooks.engine.delivery.sax.ng

Class ConsumeSerializerVisitor

java.lang.Object

org.smooks.engine.delivery.sax.ng.SimpleSerializerVisitor

org.smooks.engine.delivery.sax.ng.ConsumeSerializerVisitor

All Implemented Interfaces:

ContentHandler, DOMElementVisitor, DOMVisitAfter, DOMVisitBefore, DOMVisitor, AfterVisitor, BeforeVisitor, ChildrenVisitor, ElementVisitor, SaxNgVisitor, SerializerVisitor, Visitor

Direct Known Subclasses:

SystemConsumeSerializerVisitor

public class ConsumeSerializerVisitor
extends SimpleSerializerVisitor
implements DOMElementVisitor

Consumes a node and serializes it to the execution result stream.

Once this ConsumeSerializerVisitor consumes a node, no other ConsumeSerializerVisitor instance, including this ConsumeSerializerVisitor, can re-serialize the node.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ConsumeSerializerVisitor.ElementMemento

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	closeEmptyElements

Fields inherited from class org.smooks.engine.delivery.sax.ng.SimpleSerializerVisitor

domSerializer, rewriteEntities

Constructor Summary

Constructors

Constructor	Description
ConsumeSerializerVisitor()

Method Summary

Modifier and Type	Method	Description
protected void	closeElement(Element element, Writer writer, ExecutionContext executionContext)
protected void	onWrite(Consumer<Writer> writerConsumer, ExecutionContext executionContext, Node node)
void	setCloseEmptyElements(Optional<Boolean> closeEmptyElements)
void	visitAfter(Element element, ExecutionContext executionContext)	Visits the end of an Element.
void	visitBefore(Element element, ExecutionContext executionContext)	Visits the beginning of an Element.
void	visitChildElement(Element childElement, ExecutionContext executionContext)	Visits a child Element.
void	visitChildText(CharacterData characterData, ExecutionContext executionContext)	Visits the character data of an Element.
void	writeStartElement(Element element, ExecutionContext executionContext)

Methods inherited from class org.smooks.engine.delivery.sax.ng.SimpleSerializerVisitor

postConstruct, setRewriteEntities, writeCharacterData, writeChildElements, writeElementCDATA, writeElementComment, writeElementEntityRef, writeElementNode, writeEndElement, writeStartElement

Methods inherited from class java.lang.Object

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

Field Detail

closeEmptyElements

protected Boolean closeEmptyElements

Constructor Detail

ConsumeSerializerVisitor

public ConsumeSerializerVisitor()

Method Detail

setCloseEmptyElements

@Inject
public void setCloseEmptyElements(@Named("close.empty.elements")
                                  Optional<Boolean> closeEmptyElements)

writeStartElement

public void writeStartElement(Element element,
                              ExecutionContext executionContext)

closeElement

protected void closeElement(Element element,
                            Writer writer,
                            ExecutionContext executionContext)

visitBefore

public void visitBefore(Element element,
                        ExecutionContext executionContext)
                 throws SmooksException

Description copied from interface: BeforeVisitor

Visits the beginning of an Element.

Specified by:

visitBefore in interface BeforeVisitor

Specified by:

visitBefore in interface DOMVisitBefore

Overrides:

visitBefore in class SimpleSerializerVisitor

Parameters:

element - the Element representing the beginning of the fragment. The Element's ancestors are traversable unless the global configuration parameter maintain.element.stack is set to false. The Element's child nodes are not traversable.

executionContext - the current ExecutionContext

Throws:

SmooksException - Element processing failure.

visitChildText

public void visitChildText(CharacterData characterData,
                           ExecutionContext executionContext)
                    throws SmooksException

Description copied from interface: ChildrenVisitor

Visits the character data of an Element. This method is invoked once for each chunk of character data. A shortcut for collecting character data is to annotate the SaxNgVisitor implementation with org.smooks.engine.delivery.sax.annotation.StreamResultWriter, or stash the character data in a TextAccumulatorMemento and restore the TextAccumulatorMemento in AfterVisitor.visitAfter(Element, ExecutionContext).

Specified by:

visitChildText in interface ChildrenVisitor

Overrides:

visitChildText in class SimpleSerializerVisitor

Parameters:

characterData - the node which includes character data but not any child Elements. The Element's ancestors are traversable unless the global configuration parameter maintain.element.stack is set to false.

executionContext - the current ExecutionContext

Throws:

SmooksException

visitChildElement

public void visitChildElement(Element childElement,
                              ExecutionContext executionContext)
                       throws SmooksException

Description copied from interface: ChildrenVisitor

Visits a child Element. This method is invoked once for each child Element.

Specified by:

visitChildElement in interface ChildrenVisitor

Overrides:

visitChildElement in class SimpleSerializerVisitor

Parameters:

childElement - the child ElementElement's ancestors are traversable unless the global configuration parameter maintain.element.stack is set to false. The Element's child nodes are not traversable.

executionContext - the current ExecutionContext

Throws:

SmooksException

visitAfter

public void visitAfter(Element element,
                       ExecutionContext executionContext)
                throws SmooksException

Description copied from interface: AfterVisitor

Visits the end of an Element.

Specified by:

visitAfter in interface AfterVisitor

Specified by:

visitAfter in interface DOMVisitAfter

Overrides:

visitAfter in class SimpleSerializerVisitor

Parameters:

element - the Element representing the end of the fragment. The Element's ancestors are traversable unless the global configuration parameter maintain.element.stack is set to false. The Element's child nodes are traversable if one of the following conditions are met:

• max.node.depth global config parameter is set to 0 or greater than 1, or
• this AfterVisitor implements ParameterizedVisitor.getMaxNodeDepth() which returns an integer greater than 1

executionContext - the current ExecutionContext

Throws:

SmooksException - Element processing failure.

onWrite

protected void onWrite(Consumer<Writer> writerConsumer,
                       ExecutionContext executionContext,
                       Node node)