001/* StreamResult.java -- 002 Copyright (C) 2004, 2005 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038package javax.xml.transform.stream; 039 040import java.io.File; 041import java.io.IOException; 042import java.io.OutputStream; 043import java.io.Writer; 044import javax.xml.transform.Result; 045 046/** 047 * Specifies a stream to which to write the transformation result. 048 * 049 * @author (a href='mailto:dog@gnu.org'>Chris Burdess</a) 050 */ 051public class StreamResult 052 implements Result 053{ 054 055 /** 056 * Factory feature indicating that stream results are supported. 057 */ 058 public static final String FEATURE = 059 "http://javax.xml.transform.stream.StreamResult/feature"; 060 061 private String systemId; 062 private OutputStream outputStream; 063 private Writer writer; 064 065 /** 066 * Default constructor. 067 */ 068 public StreamResult() 069 { 070 } 071 072 /** 073 * Constructor with an output stream. 074 */ 075 public StreamResult(OutputStream stream) 076 { 077 this.outputStream = stream; 078 } 079 080 /** 081 * Constructor with a writer. 082 * Prefer to use an output stream rather than a writer, so that the 083 * output encoding can be controlled by transformation properties. 084 */ 085 public StreamResult(Writer writer) 086 { 087 this.writer = writer; 088 } 089 090 /** 091 * Constructor with a system ID. 092 */ 093 public StreamResult(String systemID) 094 { 095 this.systemId = systemID; 096 } 097 098 /** 099 * Constructor with a system ID specified as a File object. 100 */ 101 public StreamResult(File file) 102 { 103 setSystemId(file); 104 } 105 106 /** 107 * Sets the target output stream. 108 */ 109 public void setOutputStream(OutputStream outputStream) 110 { 111 this.outputStream = outputStream; 112 } 113 114 /** 115 * Returns the target output stream. 116 */ 117 public OutputStream getOutputStream() 118 { 119 return outputStream; 120 } 121 122 /** 123 * Sets the target writer. 124 * Prefer to use an output stream rather than a writer, so that the 125 * output encoding can be controlled by transformation properties. 126 */ 127 public void setWriter(Writer writer) 128 { 129 this.writer = writer; 130 } 131 132 /** 133 * Returns the target writer. 134 */ 135 public Writer getWriter() 136 { 137 return writer; 138 } 139 140 /** 141 * Sets the system ID. 142 * If neither the out stream nor the writer have been specified, the 143 * system ID will be treated as a URL for writing to. 144 */ 145 public void setSystemId(String systemID) 146 { 147 this.systemId = systemID; 148 } 149 150 /** 151 * Sets the system ID from a File reference. 152 */ 153 public void setSystemId(File f) 154 { 155 try 156 { 157 systemId = f.toURL().toString(); 158 } 159 catch (IOException e) 160 { 161 throw new RuntimeException(e.getMessage(), e); 162 } 163 } 164 165 /** 166 * Returns the system ID. 167 */ 168 public String getSystemId() 169 { 170 return systemId; 171 } 172 173}