001    /* StreamPrintService.java --
002       Copyright (C) 2004, 2006 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package javax.print;
040    
041    import java.io.OutputStream;
042    
043    
044    /**
045     * <code>StreamPrintService</code> is a special print service capable of
046     * printing into a supplied output stream.
047     * <p>
048     * Beside providing the same functionality as a print service it additionally
049     * allows to specify the output stream for the print data. A stream print
050     * service is obtained via the {@link javax.print.StreamPrintServiceFactory}
051     * by looking for services supporting a given output format type.
052     * </p>
053     *
054     * @author Michael Koch (konqueror@gmx.de)
055     */
056    public abstract class StreamPrintService implements PrintService
057    {
058      private boolean disposed;
059      private OutputStream out;
060    
061      /**
062       * Constructs a <code>StreamPrintService</code> object.
063       *
064       * @param out the <code>OutputStream</code> to use
065       */
066      protected StreamPrintService(OutputStream out)
067      {
068        this.out = out;
069      }
070    
071      /**
072       * Dispose this <code>StreamPrintService</code> object.
073       */
074      public void dispose()
075      {
076        disposed = true;
077      }
078    
079      /**
080       * Returns the document format emitted by this print service.
081       * The returned string is a MIME type compatible with the
082       * {@link DocFlavor} class.
083       *
084       * @return The document format of the output.
085       */
086      public abstract String getOutputFormat();
087    
088      /**
089       * Returns the <code>OutputStream</code> of this object.
090       *
091       * @return The <code>OutputStream</code>
092       */
093      public OutputStream getOutputStream()
094      {
095        return out;
096      }
097    
098      /**
099       * 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    }