Interface XmlWriter
-
- All Known Implementing Classes:
XmlWriterToTree
public interface XmlWriter
This interface is used to construct XML via a sequence of API calls.This is written to be similar to javax.xml.stream.XMLStreamWriter, but has slightly different requirements. Specifically, we need to be able to create an "ID" type attribute, and get the current node.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
XmlWriter.ToMarshal<CLZ extends javax.xml.crypto.XMLStructure>
Utility class that brings together the class, and the method for marshaling an instance of said class.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCurrentLocalName()
Get the local name of the current element.javax.xml.crypto.XMLStructure
getCurrentNodeAsStructure()
void
marshalStructure(javax.xml.crypto.XMLStructure toMarshal, java.lang.String dsPrefix, javax.xml.crypto.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.org.w3c.dom.Attr
writeAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
void
writeCharacters(java.lang.String text)
void
writeComment(java.lang.String text)
void
writeEndElement()
See alsoXMLStreamWriter.writeEndElement()
void
writeIdAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
void
writeNamespace(java.lang.String prefix, java.lang.String namespaceURI)
void
writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
void
writeTextElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI, java.lang.String value)
Convenience method that writes both a start and end tag, with text contents as provided.
-
-
-
Method Detail
-
writeStartElement
void writeStartElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI)
- Parameters:
prefix
- What prefix to use?localName
- What local name to use?namespaceURI
- What namespace URI? See alsoXMLStreamWriter.writeStartElement(String, String, String)
-
writeEndElement
void writeEndElement()
See alsoXMLStreamWriter.writeEndElement()
-
writeTextElement
void writeTextElement(java.lang.String prefix, java.lang.String localName, java.lang.String namespaceURI, java.lang.String value)
Convenience method that writes both a start and end tag, with text contents as provided.- Parameters:
prefix
-localName
-namespaceURI
-value
-
-
writeNamespace
void writeNamespace(java.lang.String prefix, java.lang.String namespaceURI)
-
writeCharacters
void writeCharacters(java.lang.String text)
-
writeComment
void writeComment(java.lang.String text)
-
writeAttribute
org.w3c.dom.Attr writeAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
-
writeIdAttribute
void writeIdAttribute(java.lang.String prefix, java.lang.String namespaceURI, java.lang.String localName, java.lang.String value)
-
getCurrentLocalName
java.lang.String getCurrentLocalName()
Get the local name of the current element.- Returns:
- the local name of the current element.
-
getCurrentNodeAsStructure
javax.xml.crypto.XMLStructure getCurrentNodeAsStructure()
-
marshalStructure
void marshalStructure(javax.xml.crypto.XMLStructure toMarshal, java.lang.String dsPrefix, javax.xml.crypto.XMLCryptoContext context) throws javax.xml.crypto.MarshalException
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.- Parameters:
toMarshal
- The object to be marshaled.dsPrefix
- The digital signature prefix.context
- The context for marshaling.- Throws:
javax.xml.crypto.MarshalException
- Thrown if something goes wrong during the marshaling.
-
-