Source for javax.xml.transform.stream.StreamResult

   1: /* StreamResult.java -- 
   2:    Copyright (C) 2004, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.xml.transform.stream;
  39: 
  40: import java.io.File;
  41: import java.io.IOException;
  42: import java.io.OutputStream;
  43: import java.io.Writer;
  44: import javax.xml.transform.Result;
  45: 
  46: /**
  47:  * Specifies a stream to which to write the transformation result.
  48:  *
  49:  * @author (a href='mailto:dog@gnu.org'>Chris Burdess</a)
  50:  */
  51: public class StreamResult
  52:   implements Result
  53: {
  54: 
  55:   /**
  56:    * Factory feature indicating that stream results are supported.
  57:    */
  58:   public static final String FEATURE =
  59:     "http://javax.xml.transform.stream.StreamResult/feature";
  60: 
  61:   private String systemId;
  62:   private OutputStream outputStream;
  63:   private Writer writer;
  64: 
  65:   /**
  66:    * Default constructor.
  67:    */
  68:   public StreamResult()
  69:   {
  70:   }
  71: 
  72:   /**
  73:    * Constructor with an output stream.
  74:    */
  75:   public StreamResult(OutputStream stream)
  76:   {
  77:     this.outputStream = stream;
  78:   }
  79: 
  80:   /**
  81:    * Constructor with a writer.
  82:    * Prefer to use an output stream rather than a writer, so that the
  83:    * output encoding can be controlled by transformation properties.
  84:    */
  85:   public StreamResult(Writer writer)
  86:   {
  87:     this.writer = writer;
  88:   }
  89: 
  90:   /**
  91:    * Constructor with a system ID.
  92:    */
  93:   public StreamResult(String systemID)
  94:   {
  95:     this.systemId = systemID;
  96:   }
  97: 
  98:   /**
  99:    * 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: }