APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print

public abstract Class StreamPrintService

extends Object
implements PrintService
Class Inheritance
All Implemented Interfaces
javax.print.PrintService
Known Direct Subclasses
sun.print.PSStreamPrintService
Imports
java.io.OutputStream
This class extends PrintService 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 the StreamPrintService class is obtained from a StreamPrintServiceFactory instance.

Note that a StreamPrintService is different from a PrintService, which supports a Destination attribute. A StreamPrintService always requires an output stream, whereas a PrintService optionally accepts a Destination. A StreamPrintService has no default destination for its formatted output. Additionally a StreamPrintService is expected to generate output in a format useful in other contexts. StreamPrintService's are not expected to support the Destination attribute.

Field Summary

Modifier and TypeField and Description
private boolean
disposed

Whether or not this StreamPrintService has been disposed.

private OutputStream
outStream

The output stream to which this service will send formatted print data.

Constructor Summary

AccessConstructor and Description
private
StreamPrintService()

Constructs a StreamPrintService object.

protected
StreamPrintService(OutputStream
stream to which to send formatted print data
out)

Constructs a StreamPrintService object.

Method Summary

Modifier and TypeMethod and Description
public void
dispose()

Disposes this StreamPrintService.

public abstract String

Returns:

mime type identifying the output format
getOutputFormat()

Returns the document format emitted by this print service.

public OutputStream

Returns:

the stream to which this service will send formatted print data
getOutputStream()

Gets the output stream.

public boolean

Returns:

true if this StreamPrintService has been disposed; false otherwise
isDisposed()

Returns a boolean indicating whether or not this StreamPrintService has been disposed.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

disposedback to summary
private boolean disposed

Whether or not this StreamPrintService has been disposed.

outStreamback to summary
private OutputStream outStream

The output stream to which this service will send formatted print data.

Constructor Detail

StreamPrintServiceback to summary
private StreamPrintService()

Constructs a StreamPrintService object.

StreamPrintServiceback to summary
protected StreamPrintService(OutputStream out)

Constructs a StreamPrintService object.

Parameters
out:OutputStream

stream to which to send formatted print data

Method Detail

disposeback to summary
public void dispose()

Disposes this StreamPrintService. 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.

getOutputFormatback to summary
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

Returns:String

mime type identifying the output format

See Also
DocFlavor
getOutputStreamback to summary
public OutputStream getOutputStream()

Gets the output stream.

Returns:OutputStream

the stream to which this service will send formatted print data

isDisposedback to summary
public boolean isDisposed()

Returns a boolean indicating whether or not this StreamPrintService 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:boolean

true if this StreamPrintService has been disposed; false otherwise