Interface BuildingStreamWriter
-
- All Superinterfaces:
javax.xml.stream.XMLStreamWriter
- All Known Implementing Classes:
BuildingStreamWriterImpl
public interface BuildingStreamWriter extends javax.xml.stream.XMLStreamWriterA BuildingStreamWriter allows a document to be constructed by calling the methods defined in theXMLStreamWriterinterface; after the document has been constructed, its root node may be retrieved by calling thegetDocumentNode()method.The class will attempt to generate namespace prefixes where none have been supplied, unless the
inventPrefixesoption is set to false. The preferred mode of use is to call the versions ofwriteStartElementandwriteAttributethat supply the prefix, URI, and local name in full. If the prefix is omitted, the class attempts to invent a prefix. If the URI is omitted, the name is assumed to be in no namespace. ThewriteNamespacemethod should be called only if there is a need to declare a namespace prefix that is not used on any element or attribute name.The class will check all names, URIs, and character content for conformance against XML well-formedness rules unless the
checkValuesoption is set to false.A
BuildingStreamWriterfor a particular object model can be obtained by callingDocumentBuilder.newBuildingStreamWriter().
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description XdmNodegetDocumentNode()After building the document by writing a sequence of events, retrieve the root node of the constructed document treebooleanisCheckValues()Ask whether names and values are to be checked for conformance with XML rulesvoidsetCheckValues(boolean check)Say whether names and values are to be checked for conformance with XML rules-
Methods inherited from interface javax.xml.stream.XMLStreamWriter
close, flush, getNamespaceContext, getPrefix, getProperty, setDefaultNamespace, setNamespaceContext, setPrefix, writeAttribute, writeAttribute, writeAttribute, writeCData, writeCharacters, writeCharacters, writeComment, writeDefaultNamespace, writeDTD, writeEmptyElement, writeEmptyElement, writeEmptyElement, writeEndDocument, writeEndElement, writeEntityRef, writeNamespace, writeProcessingInstruction, writeProcessingInstruction, writeStartDocument, writeStartDocument, writeStartDocument, writeStartElement, writeStartElement, writeStartElement
-
-
-
-
Method Detail
-
getDocumentNode
XdmNode getDocumentNode() throws SaxonApiException
After building the document by writing a sequence of events, retrieve the root node of the constructed document tree- Returns:
- the root node of the constructed tree. The result is undefined (maybe null, maybe an exception)
if the method is called before successfully completing the sequence of events (of which the last should be
XMLStreamWriter.writeEndDocument()) that constructs the tree. - Throws:
SaxonApiException- if any failure occurs
-
setCheckValues
void setCheckValues(boolean check)
Say whether names and values are to be checked for conformance with XML rules- Parameters:
check- true if names and values are to be checked. Default is true.
-
isCheckValues
boolean isCheckValues()
Ask whether names and values are to be checked for conformance with XML rules- Returns:
- true if names and values are to be checked. Default is true.
-
-