XMLStreamWriter (Java SE 9 & JDK 9 ) (original) (raw)

• • Method Detail

     * #### writeStartElement  
     void writeStartElement​([String](../../../java/lang/String.html "class in java.lang") localName)  
                     throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes a start tag to the output. All writeStartElement methods open a new scope in the internal namespace context. Writing the corresponding EndElement causes the scope to be closed.  
     Parameters:  
     `localName` \- local name of the tag, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeStartElement  
     void writeStartElement​([String](../../../java/lang/String.html "class in java.lang") namespaceURI,  
                            [String](../../../java/lang/String.html "class in java.lang") localName)  
                     throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes a start tag to the output  
     Parameters:  
     `namespaceURI` \- the namespaceURI of the prefix to use, may not be null  
     `localName` \- local name of the tag, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true  
     * #### writeStartElement  
     void writeStartElement​([String](../../../java/lang/String.html "class in java.lang") prefix,  
                            [String](../../../java/lang/String.html "class in java.lang") localName,  
                            [String](../../../java/lang/String.html "class in java.lang") namespaceURI)  
                     throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes a start tag to the output  
     Parameters:  
     `localName` \- local name of the tag, may not be null  
     `prefix` \- the prefix of the tag, may not be null  
     `namespaceURI` \- the uri to bind the prefix to, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeEmptyElement  
     void writeEmptyElement​([String](../../../java/lang/String.html "class in java.lang") namespaceURI,  
                            [String](../../../java/lang/String.html "class in java.lang") localName)  
                     throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an empty element tag to the output  
     Parameters:  
     `namespaceURI` \- the uri to bind the tag to, may not be null  
     `localName` \- local name of the tag, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true  
     * #### writeEmptyElement  
     void writeEmptyElement​([String](../../../java/lang/String.html "class in java.lang") prefix,  
                            [String](../../../java/lang/String.html "class in java.lang") localName,  
                            [String](../../../java/lang/String.html "class in java.lang") namespaceURI)  
                     throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an empty element tag to the output  
     Parameters:  
     `prefix` \- the prefix of the tag, may not be null  
     `localName` \- local name of the tag, may not be null  
     `namespaceURI` \- the uri to bind the tag to, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeEmptyElement  
     void writeEmptyElement​([String](../../../java/lang/String.html "class in java.lang") localName)  
                     throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an empty element tag to the output  
     Parameters:  
     `localName` \- local name of the tag, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeEndElement  
     void writeEndElement​()  
                   throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an end tag to the output relying on the internal state of the writer to determine the prefix and local name of the event.  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeEndDocument  
     void writeEndDocument​()  
                    throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Closes any start tags and writes corresponding end tags.  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### close  
     void close​()  
         throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Close this writer and free any resources associated with the writer. This must not close the underlying output stream.  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### flush  
     void flush​()  
         throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Write any cached data to the underlying output mechanism.  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeAttribute  
     void writeAttribute​([String](../../../java/lang/String.html "class in java.lang") localName,  
                         [String](../../../java/lang/String.html "class in java.lang") value)  
                  throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an attribute to the output stream without a prefix.  
     Parameters:  
     `localName` \- the local name of the attribute  
     `value` \- the value of the attribute  
     Throws:  
     `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the current state does not allow Attribute writing  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeAttribute  
     void writeAttribute​([String](../../../java/lang/String.html "class in java.lang") prefix,  
                         [String](../../../java/lang/String.html "class in java.lang") namespaceURI,  
                         [String](../../../java/lang/String.html "class in java.lang") localName,  
                         [String](../../../java/lang/String.html "class in java.lang") value)  
                  throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an attribute to the output stream  
     Parameters:  
     `prefix` \- the prefix for this attribute  
     `namespaceURI` \- the uri of the prefix for this attribute  
     `localName` \- the local name of the attribute  
     `value` \- the value of the attribute  
     Throws:  
     `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the current state does not allow Attribute writing  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true  
     * #### writeAttribute  
     void writeAttribute​([String](../../../java/lang/String.html "class in java.lang") namespaceURI,  
                         [String](../../../java/lang/String.html "class in java.lang") localName,  
                         [String](../../../java/lang/String.html "class in java.lang") value)  
                  throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an attribute to the output stream  
     Parameters:  
     `namespaceURI` \- the uri of the prefix for this attribute  
     `localName` \- the local name of the attribute  
     `value` \- the value of the attribute  
     Throws:  
     `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the current state does not allow Attribute writing  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- if the namespace URI has not been bound to a prefix and javax.xml.stream.isRepairingNamespaces has not been set to true  
     * #### writeNamespace  
     void writeNamespace​([String](../../../java/lang/String.html "class in java.lang") prefix,  
                         [String](../../../java/lang/String.html "class in java.lang") namespaceURI)  
                  throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes a namespace to the output stream If the prefix argument to this method is the empty string, "xmlns", or null this method will delegate to writeDefaultNamespace  
     Parameters:  
     `prefix` \- the prefix to bind this namespace to  
     `namespaceURI` \- the uri to bind the prefix to  
     Throws:  
     `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the current state does not allow Namespace writing  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeDefaultNamespace  
     void writeDefaultNamespace​([String](../../../java/lang/String.html "class in java.lang") namespaceURI)  
                         throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes the default namespace to the stream  
     Parameters:  
     `namespaceURI` \- the uri to bind the default namespace to  
     Throws:  
     `[IllegalStateException](../../../java/lang/IllegalStateException.html "class in java.lang")` \- if the current state does not allow Namespace writing  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeComment  
     void writeComment​([String](../../../java/lang/String.html "class in java.lang") data)  
                throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an xml comment with the data enclosed  
     Parameters:  
     `data` \- the data contained in the comment, may be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeProcessingInstruction  
     void writeProcessingInstruction​([String](../../../java/lang/String.html "class in java.lang") target)  
                              throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes a processing instruction  
     Parameters:  
     `target` \- the target of the processing instruction, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeProcessingInstruction  
     void writeProcessingInstruction​([String](../../../java/lang/String.html "class in java.lang") target,  
                                     [String](../../../java/lang/String.html "class in java.lang") data)  
                              throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes a processing instruction  
     Parameters:  
     `target` \- the target of the processing instruction, may not be null  
     `data` \- the data contained in the processing instruction, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeCData  
     void writeCData​([String](../../../java/lang/String.html "class in java.lang") data)  
              throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes a CData section  
     Parameters:  
     `data` \- the data contained in the CData Section, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeDTD  
     void writeDTD​([String](../../../java/lang/String.html "class in java.lang") dtd)  
            throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Write a DTD section. This string represents the entire doctypedecl production from the XML 1.0 specification.  
     Parameters:  
     `dtd` \- the DTD to be written  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeEntityRef  
     void writeEntityRef​([String](../../../java/lang/String.html "class in java.lang") name)  
                  throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Writes an entity reference  
     Parameters:  
     `name` \- the name of the entity  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeStartDocument  
     void writeStartDocument​()  
                      throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Write the XML Declaration. Defaults the XML version to 1.0, and the encoding to utf-8  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeStartDocument  
     void writeStartDocument​([String](../../../java/lang/String.html "class in java.lang") version)  
                      throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Write the XML Declaration. Defaults the XML version to 1.0  
     Parameters:  
     `version` \- version of the xml document  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeStartDocument  
     void writeStartDocument​([String](../../../java/lang/String.html "class in java.lang") encoding,  
                             [String](../../../java/lang/String.html "class in java.lang") version)  
                      throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Write the XML Declaration. Note that the encoding parameter does not set the actual encoding of the underlying output. That must be set when the instance of the XMLStreamWriter is created using the XMLOutputFactory  
     Parameters:  
     `encoding` \- encoding of the xml declaration  
     `version` \- version of the xml document  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")` \- If given encoding does not match encoding of the underlying stream  
     * #### writeCharacters  
     void writeCharacters​([String](../../../java/lang/String.html "class in java.lang") text)  
                   throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Write text to the output  
     Parameters:  
     `text` \- the value to write  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### writeCharacters  
     void writeCharacters​(char[] text,  
                          int start,  
                          int len)  
                   throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Write text to the output  
     Parameters:  
     `text` \- the value to write  
     `start` \- the starting position in the array  
     `len` \- the number of characters to write  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### getPrefix  
     [String](../../../java/lang/String.html "class in java.lang") getPrefix​([String](../../../java/lang/String.html "class in java.lang") uri)  
               throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Gets the prefix the uri is bound to  
     Returns:  
     the prefix or null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### setPrefix  
     void setPrefix​([String](../../../java/lang/String.html "class in java.lang") prefix,  
                    [String](../../../java/lang/String.html "class in java.lang") uri)  
             throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Sets the prefix the uri is bound to. This prefix is bound in the scope of the current START\_ELEMENT / END\_ELEMENT pair. If this method is called before a START\_ELEMENT has been written the prefix is bound in the root scope.  
     Parameters:  
     `prefix` \- the prefix to bind to the uri, may not be null  
     `uri` \- the uri to bind to the prefix, may be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### setDefaultNamespace  
     void setDefaultNamespace​([String](../../../java/lang/String.html "class in java.lang") uri)  
                       throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Binds a URI to the default namespace This URI is bound in the scope of the current START\_ELEMENT / END\_ELEMENT pair. If this method is called before a START\_ELEMENT has been written the uri is bound in the root scope.  
     Parameters:  
     `uri` \- the uri to bind to the default namespace, may be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### setNamespaceContext  
     void setNamespaceContext​([NamespaceContext](../../../javax/xml/namespace/NamespaceContext.html "interface in javax.xml.namespace") context)  
                       throws [XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")  
     Sets the current namespace context for prefix and uri bindings. This context becomes the root namespace context for writing and will replace the current root namespace context. Subsequent calls to setPrefix and setDefaultNamespace will bind namespaces using the context passed to the method as the root context for resolving namespaces. This method may only be called once at the start of the document. It does not cause the namespaces to be declared. If a namespace URI to prefix mapping is found in the namespace context it is treated as declared and the prefix may be used by the StreamWriter.  
     Parameters:  
     `context` \- the namespace context to use for this writer, may not be null  
     Throws:  
     `[XMLStreamException](../../../javax/xml/stream/XMLStreamException.html "class in javax.xml.stream")`  
     * #### getNamespaceContext  
     [NamespaceContext](../../../javax/xml/namespace/NamespaceContext.html "interface in javax.xml.namespace") getNamespaceContext​()  
     Returns the current namespace context.  
     Returns:  
     the current NamespaceContext  
     * #### getProperty  
     [Object](../../../java/lang/Object.html "class in java.lang") getProperty​([String](../../../java/lang/String.html "class in java.lang") name)  
                 throws [IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")  
     Get the value of a feature/property from the underlying implementation  
     Parameters:  
     `name` \- The name of the property, may not be null  
     Returns:  
     The value of the property  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the property is not supported  
     `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if the name is null