001 /*
002 * Copyright 2000-2001 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.print;
027
028 import java.io.OutputStream;
029
030 /**
031 * This class extends {@link PrintService} and represents a
032 * print service that prints data in different formats to a
033 * client-provided output stream.
034 * This is principally intended for services where
035 * the output format is a document type suitable for viewing
036 * or archiving.
037 * The output format must be declared as a mime type.
038 * This is equivalent to an output document flavor where the
039 * representation class is always "java.io.OutputStream"
040 * An instance of the <code>StreamPrintService</code> class is
041 * obtained from a {@link StreamPrintServiceFactory} instance.
042 * <p>
043 * Note that a <code>StreamPrintService</code> is different from a
044 * <code>PrintService</code>, which supports a
045 * {@link javax.print.attribute.standard.Destination Destination}
046 * attribute. A <code>StreamPrintService</code> always requires an output
047 * stream, whereas a <code>PrintService</code> optionally accepts a
048 * <code>Destination</code>. A <code>StreamPrintService</code>
049 * has no default destination for its formatted output.
050 * Additionally a <code>StreamPrintService</code> is expected to generate
051 output in
052 * a format useful in other contexts.
053 * StreamPrintService's are not expected to support the Destination attribute.
054 */
055
056 public abstract class StreamPrintService implements PrintService {
057
058 private OutputStream outStream;
059 private boolean disposed = false;
060
061 private StreamPrintService() {
062 };
063
064 /**
065 * Constructs a StreamPrintService object.
066 *
067 * @param out stream to which to send formatted print data.
068 */
069 protected StreamPrintService(OutputStream out) {
070 this .outStream = out;
071 }
072
073 /**
074 * Gets the output stream.
075 *
076 * @return the stream to which this service will send formatted print data.
077 */
078 public OutputStream getOutputStream() {
079 return outStream;
080 }
081
082 /**
083 * Returns the document format emitted by this print service.
084 * Must be in mimetype format, compatible with the mime type
085 * components of DocFlavors @see DocFlavor.
086 * @return mime type identifying the output format.
087 */
088 public abstract String getOutputFormat();
089
090 /**
091 * Disposes this <code>StreamPrintService</code>.
092 * If a stream service cannot be re-used, it must be disposed
093 * to indicate this. Typically the client will call this method.
094 * Services which write data which cannot meaningfully be appended to
095 * may also dispose the stream. This does not close the stream. It
096 * just marks it as not for further use by this service.
097 */
098 public void dispose() {
099 disposed = true;
100 }
101
102 /**
103 * Returns a <code>boolean</code> indicating whether or not
104 * this <code>StreamPrintService</code> has been disposed.
105 * If this object has been disposed, will return true.
106 * Used by services and client applications to recognize streams
107 * to which no further data should be written.
108 * @return if this <code>StreamPrintService</code> has been disposed
109 */
110 public boolean isDisposed() {
111 return disposed;
112 }
113
114 }
|