- java.lang.Object
-
- javax.print.StreamPrintService
-
- All Implemented Interfaces:
- PrintService
public abstract class StreamPrintService extends Object implements PrintService
This class extendsPrintService
and represents a print service that prints data in different formats to a client-provided output stream. This is principally intended for services where the output format is a document type suitable for viewing or archiving. The output format must be declared as a mime type. This is equivalent to an output document flavor where the representation class is always "java.io.OutputStream" An instance of theStreamPrintService
class is obtained from aStreamPrintServiceFactory
instance.Note that a
StreamPrintService
is different from aPrintService
, which supports aDestination
attribute. AStreamPrintService
always requires an output stream, whereas aPrintService
optionally accepts aDestination
. AStreamPrintService
has no default destination for its formatted output. Additionally aStreamPrintService
is expected to generate output in a format useful in other contexts. StreamPrintService's are not expected to support the Destination attribute.
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
StreamPrintService(OutputStream out)
Constructs a StreamPrintService object.
-
Method Summary
Methods Modifier and Type Method and Description void
dispose()
Disposes thisStreamPrintService
.abstract String
getOutputFormat()
Returns the document format emitted by this print service.OutputStream
getOutputStream()
Gets the output stream.boolean
isDisposed()
Returns aboolean
indicating whether or not thisStreamPrintService
has been disposed.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.print.PrintService
addPrintServiceAttributeListener, createPrintJob, equals, getAttribute, getAttributes, getDefaultAttributeValue, getName, getServiceUIFactory, getSupportedAttributeCategories, getSupportedAttributeValues, getSupportedDocFlavors, getUnsupportedAttributes, hashCode, isAttributeCategorySupported, isAttributeValueSupported, isDocFlavorSupported, removePrintServiceAttributeListener
-
-
-
-
Constructor Detail
-
StreamPrintService
protected StreamPrintService(OutputStream out)
Constructs a StreamPrintService object.- Parameters:
out
- stream to which to send formatted print data.
-
-
Method Detail
-
getOutputStream
public OutputStream getOutputStream()
Gets the output stream.- Returns:
- the stream to which this service will send formatted print data.
-
getOutputFormat
public abstract String getOutputFormat()
Returns the document format emitted by this print service. Must be in mimetype format, compatible with the mime type components of DocFlavors @see DocFlavor.- Returns:
- mime type identifying the output format.
-
dispose
public void dispose()
Disposes thisStreamPrintService
. If a stream service cannot be re-used, it must be disposed to indicate this. Typically the client will call this method. Services which write data which cannot meaningfully be appended to may also dispose the stream. This does not close the stream. It just marks it as not for further use by this service.
-
isDisposed
public boolean isDisposed()
Returns aboolean
indicating whether or not thisStreamPrintService
has been disposed. If this object has been disposed, will return true. Used by services and client applications to recognize streams to which no further data should be written.- Returns:
- if this
StreamPrintService
has been disposed
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/print/streamprintservice.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.