libjava/classpath/javax/print/StreamPrintService.java

   1 /* StreamPrintService.java --
   2    Copyright (C) 2004, 2006 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
  39 package javax.print;
  40
  41 import java.io.OutputStream;
  42
  43
  44 /**
  45  * <code>StreamPrintService</code> is a special print service capable of
  46  * printing into a supplied output stream.
  47  * <p>
  48  * Beside providing the same functionality as a print service it additionally
  49  * allows to specify the output stream for the print data. A stream print
  50  * service is obtained via the {@link javax.print.StreamPrintServiceFactory}
  51  * by looking for services supporting a given output format type.
  52  * </p>
  53  *
  54  * @author Michael Koch (konqueror@gmx.de)
  55  */
  56 public abstract class StreamPrintService implements PrintService
  57 {
  58   private boolean disposed;
  59   private OutputStream out;
  60
  61   /**
  62    * Constructs a <code>StreamPrintService</code> object.
  63    *
  64    * @param out the <code>OutputStream</code> to use
  65    */
  66   protected StreamPrintService(OutputStream out)
  67   {
  68     this.out = out;
  69   }
  70
  71   /**
  72    * Dispose this <code>StreamPrintService</code> object.
  73    */
  74   public void dispose()
  75   {
  76     disposed = true;
  77   }
  78
  79   /**
  80    * Returns the document format emitted by this print service.
  81    * The returned string is a MIME type compatible with the
  82    * {@link DocFlavor} class.
  83    *
  84    * @return The document format of the output.
  85    */
  86   public abstract String getOutputFormat();
  87
  88   /**
  89    * Returns the <code>OutputStream</code> of this object.
  90    *
  91    * @return The <code>OutputStream</code>
  92    */
  93   public OutputStream getOutputStream()
  94   {
  95     return out;
  96   }
  97
  98   /**
  99    * Determines if this <code>StreamPrintService</code> object is disposed.
 100    *
 101    * @return <code>true</code> if disposed already,
 102    * otherwise <code>false</code>
 103    */
 104   public boolean isDisposed()
 105   {
 106     return disposed;
 107   }
 108 }