Java example source code file (StAXResult.java)

This example Java source code file (StAXResult.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

feature, illegalargumentexception, staxresult, string, unsupportedoperationexception, xmleventwriter, xmlstreamwriter

The StAXResult.java Java example source code

/*
 * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.xml.transform.stax;

import javax.xml.stream.XMLEventWriter;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.Result;

/**
 * <p>Acts as a holder for an XML {@link Result} in the
 * form of a StAX writer,i.e.
 * {@link XMLStreamWriter} or {@link XMLEventWriter}.
 * <code>StAXResult can be used in all cases that accept
 * a <code>Result, e.g. {@link javax.xml.transform.Transformer},
 * {@link javax.xml.validation.Validator} which accept
 * <code>Result as input.
 *
 * @author <a href="mailto:Neeraj.Bajaj@Sun.com">Neeraj Bajaj
 * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor
 *
 * @see <a href="http://jcp.org/en/jsr/detail?id=173">
 *  JSR 173: Streaming API for XML</a>
 * @see XMLStreamWriter
 * @see XMLEventWriter
 *
 * @since 1.6
 */
public class StAXResult implements Result {
    /** If {@link javax.xml.transform.TransformerFactory#getFeature(String name)}
     * returns true when passed this value as an argument,
     * the Transformer supports Result output of this type.
     */
    public static final String FEATURE =
        "http://javax.xml.transform.stax.StAXResult/feature";

    /**
     * <p>XMLEventWriter to be used for
     * <code>Result output.

     */
    private XMLEventWriter xmlEventWriter = null;

    /**
     * <p>XMLStreamWriter to be used for
     * <code>Result output.

     */
    private XMLStreamWriter xmlStreamWriter = null;

    /** <p>System identifier for this StAXResult.
 */
    private String systemId = null;

    /**
     * <p>Creates a new instance of a StAXResult
     * by supplying an {@link XMLEventWriter}.</p>
     *
     * <p>XMLEventWriter must be a
     * non-<code>null reference.
     *
     * @param xmlEventWriter <code>XMLEventWriter used to create
     *   this <code>StAXResult.
     *
     * @throws IllegalArgumentException If <code>xmlEventWriter ==
     *   <code>null.
     */
    public StAXResult(final XMLEventWriter xmlEventWriter) {

        if (xmlEventWriter == null) {
            throw new IllegalArgumentException(
                    "StAXResult(XMLEventWriter) with XMLEventWriter == null");
        }

        this.xmlEventWriter = xmlEventWriter;
    }

    /**
     * <p>Creates a new instance of a StAXResult
     * by supplying an {@link XMLStreamWriter}.</p>
     *
     * <p>XMLStreamWriter must be a
     * non-<code>null reference.

     *
     * @param xmlStreamWriter <code>XMLStreamWriter used to create
     *   this <code>StAXResult.
     *
     * @throws IllegalArgumentException If <code>xmlStreamWriter ==
     *   <code>null.
     */
    public StAXResult(final XMLStreamWriter xmlStreamWriter) {

        if (xmlStreamWriter == null) {
            throw new IllegalArgumentException(
                    "StAXResult(XMLStreamWriter) with XMLStreamWriter == null");
        }

        this.xmlStreamWriter = xmlStreamWriter;
    }

    /**
     * <p>Get the XMLEventWriter used by this
     * <code>StAXResult.

     *
     * <p>XMLEventWriter will be null
     * if this <code>StAXResult was created with a
     * <code>XMLStreamWriter.

     *
     * @return <code>XMLEventWriter used by this
     *   <code>StAXResult.
     */
    public XMLEventWriter getXMLEventWriter() {

        return xmlEventWriter;
    }

    /**
     * <p>Get the XMLStreamWriter used by this
     * <code>StAXResult.

     *
     * <p>XMLStreamWriter will be null
     * if this <code>StAXResult was created with a
     * <code>XMLEventWriter.

     *
     * @return <code>XMLStreamWriter used by this
     *   <code>StAXResult.
     */
    public XMLStreamWriter getXMLStreamWriter() {

        return xmlStreamWriter;
    }

    /**
     * <p>In the context of a StAXResult, it is not appropriate
     * to explicitly set the system identifier.
     * The <code>XMLEventWriter or XMLStreamWriter
     * used to construct this <code>StAXResult determines the
     * system identifier of the XML result.</p>
     *
     * <p>An {@link UnsupportedOperationException} is always
     * thrown by this method.</p>
     *
     * @param systemId Ignored.
     *
     * @throws UnsupportedOperationException Is <strong>always
     *   thrown by this method.
     */
    public void setSystemId(final String systemId) {

        throw new UnsupportedOperationException(
                "StAXResult#setSystemId(systemId) cannot set the "
                + "system identifier for a StAXResult");
    }

    /**
     * <p>The returned system identifier is always null.

     *
     * @return The returned system identifier is always <code>null.
     */
    public String getSystemId() {

        return null;
    }
}