001/* StreamSource.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.InputStream; 042import java.io.IOException; 043import java.io.Reader; 044import javax.xml.transform.Source; 045 046/** 047 * Specifies a stream from which to read the source XML data. 048 * 049 * @author (a href='mailto:dog@gnu.org'>Chris Burdess</a) 050 */ 051public class StreamSource 052 implements Source 053{ 054 055 /** 056 * Factory feature indicating that stream sources are supported. 057 */ 058 public static final String FEATURE = 059 "http://javax.xml.transform.stream.StreamSource/feature"; 060 061 private String publicId; 062 private String systemId; 063 private InputStream inputStream; 064 private Reader reader; 065 066 /** 067 * Default constructor. 068 */ 069 public StreamSource() 070 { 071 } 072 073 /** 074 * Constructor with an input stream. 075 */ 076 public StreamSource(InputStream stream) 077 { 078 this.inputStream = stream; 079 } 080 081 /** 082 * Constructor with an input stream and system ID. 083 */ 084 public StreamSource(InputStream stream, String systemId) 085 { 086 this.inputStream = stream; 087 this.systemId = systemId; 088 } 089 090 /** 091 * Constructor with a reader. 092 * Prefer an input stream to a reader, so that the parser can use the 093 * character encoding specified in the XML. 094 */ 095 public StreamSource(Reader reader) 096 { 097 this.reader = reader; 098 } 099 100 /** 101 * Constructor with a reader and system ID. 102 * Prefer an input stream to a reader, so that the parser can use the 103 * character encoding specified in the XML. 104 */ 105 public StreamSource(Reader reader, String systemId) 106 { 107 this.reader = reader; 108 this.systemId = systemId; 109 } 110 111 /** 112 * Constructor with a system ID. 113 */ 114 public StreamSource(String systemId) 115 { 116 this.systemId = systemId; 117 } 118 119 /** 120 * Constructor with a system ID specified as a File reference. 121 */ 122 public StreamSource(File file) 123 { 124 setSystemId(file); 125 } 126 127 /** 128 * Sets the source input stream. 129 */ 130 public void setInputStream(InputStream stream) 131 { 132 this.inputStream = stream; 133 } 134 135 /** 136 * Returns the source input stream. 137 */ 138 public InputStream getInputStream() 139 { 140 return inputStream; 141 } 142 143 /** 144 * Sets the source reader. 145 * Prefer an input stream to a reader, so that the parser can use the 146 * character encoding specified in the XML. 147 */ 148 public void setReader(Reader reader) 149 { 150 this.reader = reader; 151 } 152 153 /** 154 * Returns the source reader. 155 */ 156 public Reader getReader() 157 { 158 return reader; 159 } 160 161 /** 162 * Sets the public ID for this source. 163 */ 164 public void setPublicId(String publicId) 165 { 166 this.publicId = publicId; 167 } 168 169 /** 170 * Returns the public ID for this source. 171 */ 172 public String getPublicId() 173 { 174 return publicId; 175 } 176 177 /** 178 * Sets the system ID for this source. 179 * If the input stream and reader are absent, the system ID will be used 180 * as a readable URL to locate the source data. 181 */ 182 public void setSystemId(String systemId) 183 { 184 this.systemId = systemId; 185 } 186 187 /** 188 * Returns the system ID for this source. 189 */ 190 public String getSystemId() 191 { 192 return systemId; 193 } 194 195 /** 196 * Sets the system ID using a File reference. 197 */ 198 public void setSystemId(File f) 199 { 200 try 201 { 202 this.systemId = f.toURL().toString(); 203 } 204 catch (IOException e) 205 { 206 throw new RuntimeException(e.getMessage(), e); 207 } 208 } 209 210}