org.wildfly.testing.tools.xml.CloseableXMLStreamWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-testing-tools Show documentation

Testing utilities for using Arquillian with WildFly. These include add deployment descriptors and modules to WildFly for testing.

The newest version!

/*
 * Copyright The WildFly Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package org.wildfly.testing.tools.xml;

import java.io.OutputStream;
import java.io.Writer;

import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

/**
 * A simple {@link XMLStreamWriter} which also implements {@link AutoCloseable}.
 *
 * @author James R. Perkins
 */
public interface CloseableXMLStreamWriter extends AutoCloseable, XMLStreamWriter {

    /**
     * Creates an {@link XMLStreamWriter} which writes to the output stream.
     *
     * @param out the output stream to write to
     *
     * @return a closable XML stream writer
     *
     * @throws XMLStreamException if an error occurs creating the writer
     */
    static CloseableXMLStreamWriter of(final OutputStream out) throws XMLStreamException {
        final XMLOutputFactory factory = XMLOutputFactory.newInstance();
        return new IndentingXmlWriter(factory.createXMLStreamWriter(out, "utf-8"));
    }

    /**
     * Creates an {@link XMLStreamWriter} which writes to the output stream.
     *
     * @param writer the writer to write to
     *
     * @return a closable XML stream writer
     *
     * @throws XMLStreamException if an error occurs creating the writer
     */
    static CloseableXMLStreamWriter of(final Writer writer) throws XMLStreamException {
        final XMLOutputFactory factory = XMLOutputFactory.newInstance();
        return new IndentingXmlWriter(factory.createXMLStreamWriter(writer));
    }
}