| /* |
| * Copyright (c) 2000, 2005, 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.stream; |
| |
| import javax.xml.transform.Result; |
| |
| import java.io.File; |
| import java.io.OutputStream; |
| import java.io.Writer; |
| import java.net.MalformedURLException; |
| |
| /** |
| * <p>Acts as an holder for a transformation result, |
| * which may be XML, plain Text, HTML, or some other form of markup.</p> |
| * |
| * @author <a href="Jeff.Suttor@Sun.com">Jeff Suttor</a> |
| * @since 1.4 |
| */ |
| public class StreamResult implements Result { |
| |
| /** If {@link javax.xml.transform.TransformerFactory#getFeature} |
| * 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.stream.StreamResult/feature"; |
| |
| /** |
| * Zero-argument default constructor. |
| */ |
| public StreamResult() { |
| } |
| |
| /** |
| * Construct a StreamResult from a byte stream. Normally, |
| * a stream should be used rather than a reader, so that |
| * the transformer may use instructions contained in the |
| * transformation instructions to control the encoding. |
| * |
| * @param outputStream A valid OutputStream reference. |
| */ |
| public StreamResult(OutputStream outputStream) { |
| setOutputStream(outputStream); |
| } |
| |
| /** |
| * Construct a StreamResult from a character stream. Normally, |
| * a stream should be used rather than a reader, so that |
| * the transformer may use instructions contained in the |
| * transformation instructions to control the encoding. However, |
| * there are times when it is useful to write to a character |
| * stream, such as when using a StringWriter. |
| * |
| * @param writer A valid Writer reference. |
| */ |
| public StreamResult(Writer writer) { |
| setWriter(writer); |
| } |
| |
| /** |
| * Construct a StreamResult from a URL. |
| * |
| * @param systemId Must be a String that conforms to the URI syntax. |
| */ |
| public StreamResult(String systemId) { |
| this.systemId = systemId; |
| } |
| |
| /** |
| * Construct a StreamResult from a File. |
| * |
| * @param f Must a non-null File reference. |
| */ |
| public StreamResult(File f) { |
| //convert file to appropriate URI, f.toURI().toASCIIString() |
| //converts the URI to string as per rule specified in |
| //RFC 2396, |
| setSystemId(f.toURI().toASCIIString()); |
| } |
| |
| /** |
| * Set the ByteStream that is to be written to. Normally, |
| * a stream should be used rather than a reader, so that |
| * the transformer may use instructions contained in the |
| * transformation instructions to control the encoding. |
| * |
| * @param outputStream A valid OutputStream reference. |
| */ |
| public void setOutputStream(OutputStream outputStream) { |
| this.outputStream = outputStream; |
| } |
| |
| /** |
| * Get the byte stream that was set with setOutputStream. |
| * |
| * @return The byte stream that was set with setOutputStream, or null |
| * if setOutputStream or the ByteStream constructor was not called. |
| */ |
| public OutputStream getOutputStream() { |
| return outputStream; |
| } |
| |
| /** |
| * Set the writer that is to receive the result. Normally, |
| * a stream should be used rather than a writer, so that |
| * the transformer may use instructions contained in the |
| * transformation instructions to control the encoding. However, |
| * there are times when it is useful to write to a writer, |
| * such as when using a StringWriter. |
| * |
| * @param writer A valid Writer reference. |
| */ |
| public void setWriter(Writer writer) { |
| this.writer = writer; |
| } |
| |
| /** |
| * Get the character stream that was set with setWriter. |
| * |
| * @return The character stream that was set with setWriter, or null |
| * if setWriter or the Writer constructor was not called. |
| */ |
| public Writer getWriter() { |
| return writer; |
| } |
| |
| /** |
| * Set the systemID that may be used in association |
| * with the byte or character stream, or, if neither is set, use |
| * this value as a writeable URI (probably a file name). |
| * |
| * @param systemId The system identifier as a URI string. |
| */ |
| public void setSystemId(String systemId) { |
| this.systemId = systemId; |
| } |
| |
| /** |
| * <p>Set the system ID from a <code>File</code> reference.</p> |
| * |
| * |
| * @param f Must a non-null File reference. |
| */ |
| public void setSystemId(File f) { |
| //convert file to appropriate URI, f.toURI().toASCIIString() |
| //converts the URI to string as per rule specified in |
| //RFC 2396, |
| this.systemId = f.toURI().toASCIIString(); |
| } |
| |
| /** |
| * Get the system identifier that was set with setSystemId. |
| * |
| * @return The system identifier that was set with setSystemId, or null |
| * if setSystemId was not called. |
| */ |
| public String getSystemId() { |
| return systemId; |
| } |
| |
| ////////////////////////////////////////////////////////////////////// |
| // Internal state. |
| ////////////////////////////////////////////////////////////////////// |
| |
| /** |
| * The systemID that may be used in association |
| * with the byte or character stream, or, if neither is set, use |
| * this value as a writeable URI (probably a file name). |
| */ |
| private String systemId; |
| |
| /** |
| * The byte stream that is to be written to. |
| */ |
| private OutputStream outputStream; |
| |
| /** |
| * The character stream that is to be written to. |
| */ |
| private Writer writer; |
| } |