Java XML Document Save to File save(Document document, OutputStream out, Properties outputProperties)

Description

Writes the Document to the specified OutputStream.

License

LGPL

Parameter

Parameter	Description
document	the <code>Document</code>
out	the <code>OutputStream</code>
outputProperties	output properties passed to XML transformer

Exception

Parameter	Description
SAXException	an exception

Declaration

public static void save(Document document, OutputStream out, Properties outputProperties) throws SAXException 

Method Source Code

//package com.java2s;
/* //www  .  j  av a2s. c  o  m
 * This file is part of the Echo Web Application Framework (hereinafter "Echo").
 * Copyright (C) 2002-2009 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

import java.io.OutputStream;
import java.io.PrintWriter;

import java.util.Properties;

import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;

import org.w3c.dom.Document;

import org.xml.sax.SAXException;

public class Main {
    /**
     * ThreadLocal cache of <code>TransformerFactory</code> instances.
     */
    private static final ThreadLocal transformerFactories = new ThreadLocal() {

        /**
         * @see java.lang.ThreadLocal#initialValue()
         */
        protected Object initialValue() {
            TransformerFactory factory = TransformerFactory.newInstance();
            return factory;
        }
    };

    /**
     * Writes the <code>Document</code> to the specified <code>OutputStream</code>.
     * 
     * @param document the <code>Document</code>
     * @param out the <code>OutputStream</code>
     * @param outputProperties output properties passed to XML transformer
     * @throws SAXException
     */
    public static void save(Document document, OutputStream out, Properties outputProperties) throws SAXException {
        saveImpl(document, new StreamResult(out), outputProperties);
    }

    /**
     * Writes the <code>Document</code> to the specified <code>PrintWriter</code>.
     * 
     * @param document the <code>Document</code>
     * @param w the <code>PrintWriter</code>
     * @param outputProperties output properties passed to XML transformer
     * @throws SAXException
     */
    public static void save(Document document, PrintWriter w, Properties outputProperties) throws SAXException {
        saveImpl(document, new StreamResult(w), outputProperties);
    }

    /**
     * Work method for public save() methods.
     */
    private static void saveImpl(Document document, StreamResult output, Properties outputProperties)
            throws SAXException {
        try {
            TransformerFactory tFactory = getTransformerFactory();
            Transformer transformer = tFactory.newTransformer();
            if (outputProperties != null) {
                transformer.setOutputProperties(outputProperties);
            }
            DOMSource source = new DOMSource(document);

            transformer.transform(source, output);
        } catch (TransformerException ex) {
            throw new SAXException("Unable to write document to OutputStream.", ex);
        }
    }

    /**
     * Retrieves a thread-specific <code>TransformerFactory</code>.
     * 
     * @return the <code>TransformerFactory</code> serving the current thread.
     */
    public static TransformerFactory getTransformerFactory() {
        return (TransformerFactory) transformerFactories.get();
    }
}

Related

1. save(Document doc, File file)
2. save(Document doc, String file, String encoding)
3. save(Document document, OutputStream outputStream)
4. save(Document document, String fileName)
5. save(Document document, String path)
6. save(final String path, final Document xml)