org.milyn.cdres.serialize

Class EmptyElementSU

java.lang.Object

org.milyn.delivery.dom.serialize.DefaultSerializationUnit

org.milyn.cdres.serialize.EmptyElementSU

All Implemented Interfaces:

ContentHandler, SerializationUnit, Visitor

public class EmptyElementSU
extends DefaultSerializationUnit

Empty element serialization unit.

Writes empty elements well-formed (<xxx/>) or badly-formed (<xxx>). If applied to an element, it also ensures that any child content is not writen to the requesting device.

.cdrl Configuration

 <smooks-resource    useragent="device/profile" selector="target-element-name" 
        path="org.milyn.cdres.serialize.EmptyElementSU">
        <!-- (Optional) Should the empty element be printed "well-formed". Default true. -->
        <param name="wellFormed">true/false</param>
 </smooks-resource>

See SmooksResourceConfiguration.

Author:

tfennelly

Constructor Summary

Constructors

Constructor and Description
EmptyElementSU()

Method Summary

Modifier and Type	Method and Description
String	getDetailDescription()
String	getShortDescription()
boolean	writeChildElements() Write the child elements of the element this SerializationUnit is being applied to.
void	writeElementCDATA(CDATASection cdata, Writer writer, ExecutionContext executionContext) Write element CDATA section.
void	writeElementComment(Comment comment, Writer writer, ExecutionContext executionContext) Write element comment.
void	writeElementEnd(Element element, Writer writer, ExecutionContext executionContext) Write the element end portion; close the element.
void	writeElementEntityRef(EntityReference entityRef, Writer writer, ExecutionContext executionContext) Write element entity reference object.
void	writeElementNode(Node node, Writer writer, ExecutionContext executionContext) Write element Node object.
void	writeElementStart(Element element, Writer writer, ExecutionContext executionContext) Write the element start portion; the element name and it's attributes.
void	writeElementText(Text text, Writer writer, ExecutionContext executionContext) Write element text.

Methods inherited from class org.milyn.delivery.dom.serialize.DefaultSerializationUnit

isRewriteEntities, setCloseEmptyElements, setRewriteEntities, writeAttributes, writeElementEnd, writeElementStart

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyElementSU

public EmptyElementSU()

Method Detail

writeElementStart

public void writeElementStart(Element element,
                              Writer writer,
                              ExecutionContext executionContext)
                       throws IOException

Description copied from interface: SerializationUnit

Write the element start portion; the element name and it's attributes.

EG: <a href="http://www.x.com">

Specified by:

writeElementStart in interface SerializationUnit

Overrides:

writeElementStart in class DefaultSerializationUnit

Parameters:

element - The element start to write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

writeElementEnd

public void writeElementEnd(Element element,
                            Writer writer,
                            ExecutionContext executionContext)
                     throws IOException

Description copied from interface: SerializationUnit

Write the element end portion; close the element.

EG: </a>

Specified by:

writeElementEnd in interface SerializationUnit

Overrides:

writeElementEnd in class DefaultSerializationUnit

Parameters:

element - The element end to write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

writeElementText

public void writeElementText(Text text,
                             Writer writer,
                             ExecutionContext executionContext)
                      throws IOException

Description copied from interface: SerializationUnit

Write element text.

Specified by:

writeElementText in interface SerializationUnit

Overrides:

writeElementText in class DefaultSerializationUnit

Parameters:

text - The Text object to write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

writeElementComment

public void writeElementComment(Comment comment,
                                Writer writer,
                                ExecutionContext executionContext)
                         throws IOException

Description copied from interface: SerializationUnit

Write element comment.

Specified by:

writeElementComment in interface SerializationUnit

Overrides:

writeElementComment in class DefaultSerializationUnit

Parameters:

comment - The comment o write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

writeElementEntityRef

public void writeElementEntityRef(EntityReference entityRef,
                                  Writer writer,
                                  ExecutionContext executionContext)
                           throws IOException

Description copied from interface: SerializationUnit

Write element entity reference object.

Specified by:

writeElementEntityRef in interface SerializationUnit

Overrides:

writeElementEntityRef in class DefaultSerializationUnit

Parameters:

entityRef - The entity reference to write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

writeElementCDATA

public void writeElementCDATA(CDATASection cdata,
                              Writer writer,
                              ExecutionContext executionContext)
                       throws IOException

Description copied from interface: SerializationUnit

Write element CDATA section.

Specified by:

writeElementCDATA in interface SerializationUnit

Overrides:

writeElementCDATA in class DefaultSerializationUnit

Parameters:

cdata - The CDATA section to write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

writeElementNode

public void writeElementNode(Node node,
                             Writer writer,
                             ExecutionContext executionContext)
                      throws IOException

Description copied from interface: SerializationUnit

Write element Node object.

Called to write DOM types not covered by the other methods on this interface.

Specified by:

writeElementNode in interface SerializationUnit

Overrides:

writeElementNode in class DefaultSerializationUnit

Parameters:

node - The node to write.

writer - The writer to be written to.

executionContext - ExecutionContext instance for the delivery context.

Throws:

IOException - Exception writing output.

getShortDescription

public String getShortDescription()

getDetailDescription

public String getDetailDescription()

writeChildElements

public boolean writeChildElements()

Description copied from interface: SerializationUnit

Write the child elements of the element this SerializationUnit is being applied to.

Specified by:

writeChildElements in interface SerializationUnit

Overrides:

writeChildElements in class DefaultSerializationUnit

Returns:

True if the child elements are to be writen, otherwise false.