/* * 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; /** *
Acts as a holder for an XML {@link Result} in the
* form of a StAX writer,i.e.
* {@link XMLStreamWriter} or {@link XMLEventWriter}.
* StAXResult
can be used in all cases that accept
* a Result
, e.g. {@link javax.xml.transform.Transformer},
* {@link javax.xml.validation.Validator} which accept
* Result
as input.
*
* @author Neeraj Bajaj
* @author Jeff Suttor
*
* @see
* JSR 173: Streaming API for XML
* @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";
/**
*
XMLEventWriter
to be used for
* Result
output.
XMLStreamWriter
to be used for
* Result
output.
System identifier for this StAXResult
.
*/ private String systemId = null; /** *
Creates a new instance of a StAXResult
* by supplying an {@link XMLEventWriter}.
XMLEventWriter
must be a
* non-null
reference.
XMLEventWriter
used to create
* this StAXResult
.
*
* @throws IllegalArgumentException If xmlEventWriter
==
* null
.
*/
public StAXResult(final XMLEventWriter xmlEventWriter) {
if (xmlEventWriter == null) {
throw new IllegalArgumentException(
"StAXResult(XMLEventWriter) with XMLEventWriter == null");
}
this.xmlEventWriter = xmlEventWriter;
}
/**
* Creates a new instance of a StAXResult
* by supplying an {@link XMLStreamWriter}.
XMLStreamWriter
must be a
* non-null
reference.
XMLStreamWriter
used to create
* this StAXResult
.
*
* @throws IllegalArgumentException If xmlStreamWriter
==
* null
.
*/
public StAXResult(final XMLStreamWriter xmlStreamWriter) {
if (xmlStreamWriter == null) {
throw new IllegalArgumentException(
"StAXResult(XMLStreamWriter) with XMLStreamWriter == null");
}
this.xmlStreamWriter = xmlStreamWriter;
}
/**
* Get the XMLEventWriter
used by this
* StAXResult
.
XMLEventWriter
will be null
* if this StAXResult
was created with a
* XMLStreamWriter
.
XMLEventWriter
used by this
* StAXResult
.
*/
public XMLEventWriter getXMLEventWriter() {
return xmlEventWriter;
}
/**
* Get the XMLStreamWriter
used by this
* StAXResult
.
XMLStreamWriter
will be null
* if this StAXResult
was created with a
* XMLEventWriter
.
XMLStreamWriter
used by this
* StAXResult
.
*/
public XMLStreamWriter getXMLStreamWriter() {
return xmlStreamWriter;
}
/**
* In the context of a StAXResult
, it is not appropriate
* to explicitly set the system identifier.
* The XMLEventWriter
or XMLStreamWriter
* used to construct this StAXResult
determines the
* system identifier of the XML result.
An {@link UnsupportedOperationException} is always * thrown by this method.
* * @param systemId Ignored. * * @throws UnsupportedOperationException Is 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"); } /** *The returned system identifier is always null
.
null
.
*/
public String getSystemId() {
return null;
}
}