Package org.apache.jcp.xml.dsig.internal.dom

Class XmlWriterToTree

java.lang.Object

org.apache.jcp.xml.dsig.internal.dom.XmlWriterToTree

All Implemented Interfaces:

XmlWriter

public class XmlWriterToTree
extends Object
implements XmlWriter

Manifestation of XmlWriter interface designed to write to a tree.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jcp.xml.dsig.internal.dom.XmlWriter

XmlWriter.ToMarshal<CLZ extends XMLStructure>

Constructor Summary

Constructors

Constructor	Description
XmlWriterToTree(List<XmlWriter.ToMarshal<? extends XMLStructure>> marshallers, Node parent)
XmlWriterToTree(List<XmlWriter.ToMarshal<? extends XMLStructure>> marshallers, Node parent, Node nextSibling)	In cases where the serialization is supposed to precede a specific element, we add an extra parameter to capture that.

Method Summary

Modifier and Type	Method	Description
Element	getCreatedElement()	Get the root element created with this writer.
String	getCurrentLocalName()	Get the local name of the current element.
XMLStructure	getCurrentNodeAsStructure()
void	marshalStructure(XMLStructure toMarshal, String dsPrefix, XMLCryptoContext context)	This method marshals a structure, and relies on implementation specific details for how an instance of a particular class maps to the method that actually does the marshaling.
void	resetToNewParent(Node newParent)	Reset to a new parent so that the writer can be re-used.
Attr	writeAttribute(String prefix, String namespaceURI, String localName, String value)
void	writeCharacters(String text)
void	writeComment(String text)
void	writeEndElement()	See also XMLStreamWriter.writeEndElement()
void	writeIdAttribute(String prefix, String namespaceURI, String localName, String value)
void	writeNamespace(String prefix, String namespaceURI)
void	writeStartElement(String prefix, String localName, String namespaceURI)
void	writeTextElement(String prefix, String localName, String namespaceURI, String value)	Convenience method that writes both a start and end tag, with text contents as provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlWriterToTree

public XmlWriterToTree(List<XmlWriter.ToMarshal<? extends XMLStructure>> marshallers,
                       Node parent)

XmlWriterToTree

public XmlWriterToTree(List<XmlWriter.ToMarshal<? extends XMLStructure>> marshallers,
                       Node parent,
                       Node nextSibling)

In cases where the serialization is supposed to precede a specific element, we add an extra parameter to capture that. Only affects the first element insertion (obviously?).

Parameters:

marshallers -

parent -

nextSibling - The first element created will be created *before* this element.

Method Detail

resetToNewParent

public void resetToNewParent(Node newParent)

Reset to a new parent so that the writer can be re-used.

Parameters:

newParent -

getCreatedElement

public Element getCreatedElement()

Get the root element created with this writer.

Returns:

the root element created with this writer.

writeStartElement

public void writeStartElement(String prefix,
                              String localName,
                              String namespaceURI)

Specified by:

writeStartElement in interface XmlWriter

Parameters:

prefix - What prefix to use?

localName - What local name to use?

namespaceURI - What namespace URI? See also XMLStreamWriter.writeStartElement(String, String, String)

writeEndElement

public void writeEndElement()

Description copied from interface: XmlWriter

See also XMLStreamWriter.writeEndElement()

Specified by:

writeEndElement in interface XmlWriter

writeTextElement

public void writeTextElement(String prefix,
                             String localName,
                             String namespaceURI,
                             String value)

Description copied from interface: XmlWriter

Convenience method that writes both a start and end tag, with text contents as provided.

Specified by:

writeTextElement in interface XmlWriter

writeNamespace

public void writeNamespace(String prefix,
                           String namespaceURI)

Specified by:

writeNamespace in interface XmlWriter

writeCharacters

public void writeCharacters(String text)

Specified by:

writeCharacters in interface XmlWriter

writeComment

public void writeComment(String text)

Specified by:

writeComment in interface XmlWriter

writeAttribute

public Attr writeAttribute(String prefix,
                           String namespaceURI,
                           String localName,
                           String value)

Specified by:

writeAttribute in interface XmlWriter

writeIdAttribute

public void writeIdAttribute(String prefix,
                             String namespaceURI,
                             String localName,
                             String value)

Specified by:

writeIdAttribute in interface XmlWriter

getCurrentLocalName

public String getCurrentLocalName()

Description copied from interface: XmlWriter

Get the local name of the current element.

Specified by:

getCurrentLocalName in interface XmlWriter

Returns:

the local name of the current element.

getCurrentNodeAsStructure

public XMLStructure getCurrentNodeAsStructure()

Specified by:

getCurrentNodeAsStructure in interface XmlWriter

marshalStructure

public void marshalStructure(XMLStructure toMarshal,
                             String dsPrefix,
                             XMLCryptoContext context)
                      throws MarshalException

Description copied from interface: XmlWriter

This method marshals a structure, and relies on implementation specific details for how an instance of a particular class maps to the method that actually does the marshaling.

Specified by:

marshalStructure in interface XmlWriter

Parameters:

toMarshal - The object to be marshaled.

dsPrefix - The digital signature prefix.

context - The context for marshaling.

Throws:

MarshalException - Thrown if something goes wrong during the marshaling.