javax.print
Class StreamPrintServiceFactory

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.StreamPrintServiceFactory

public abstract class StreamPrintServiceFactory
extends Object sample code for java.lang.Object definition code for java.lang.Object

A StreamPrintServiceFactory is the factory for StreamPrintService sample code for javax.print.StreamPrintService definition code for javax.print.StreamPrintService instances, which can print to an output stream in a particular document format described as a mime type. A typical output document format may be Postscript(TM).

This class is implemented by a service and located by the implementation using the SPI JAR File specification.

Applications locate instances of this class by calling the lookupStreamPrintServiceFactories(DocFlavor, String) sample code for javax.print.StreamPrintServiceFactory.lookupStreamPrintServiceFactories(javax.print.DocFlavor, java.lang.String) definition code for javax.print.StreamPrintServiceFactory.lookupStreamPrintServiceFactories(javax.print.DocFlavor, java.lang.String) method.

Applications can use a StreamPrintService obtained from a factory in place of a PrintService which represents a physical printer device.


Constructor Summary
StreamPrintServiceFactory sample code for javax.print.StreamPrintServiceFactory.StreamPrintServiceFactory() definition code for javax.print.StreamPrintServiceFactory.StreamPrintServiceFactory() ()
           
 
Method Summary
abstract  String sample code for java.lang.String definition code for java.lang.String getOutputFormat sample code for javax.print.StreamPrintServiceFactory.getOutputFormat() definition code for javax.print.StreamPrintServiceFactory.getOutputFormat() ()
          Queries the factory for the document format that is emitted by printers obtained from this factory.
abstract  StreamPrintService sample code for javax.print.StreamPrintService definition code for javax.print.StreamPrintService getPrintService sample code for javax.print.StreamPrintServiceFactory.getPrintService(java.io.OutputStream) definition code for javax.print.StreamPrintServiceFactory.getPrintService(java.io.OutputStream) (OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream  out)
          Returns a StreamPrintService that can print to the specified output stream.
abstract  DocFlavor sample code for javax.print.DocFlavor definition code for javax.print.DocFlavor [] getSupportedDocFlavors sample code for javax.print.StreamPrintServiceFactory.getSupportedDocFlavors() definition code for javax.print.StreamPrintServiceFactory.getSupportedDocFlavors() ()
          Queries the factory for the document flavors that can be accepted by printers obtained from this factory.
static StreamPrintServiceFactory sample code for javax.print.StreamPrintServiceFactory definition code for javax.print.StreamPrintServiceFactory [] lookupStreamPrintServiceFactories sample code for javax.print.StreamPrintServiceFactory.lookupStreamPrintServiceFactories(javax.print.DocFlavor, java.lang.String) definition code for javax.print.StreamPrintServiceFactory.lookupStreamPrintServiceFactories(javax.print.DocFlavor, java.lang.String) (DocFlavor sample code for javax.print.DocFlavor definition code for javax.print.DocFlavor  flavor, String sample code for java.lang.String definition code for java.lang.String  outputMimeType)
          Locates factories for print services that can be used with a print job to output a stream of data in the format specified by flavor.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

StreamPrintServiceFactory sample code for javax.print.StreamPrintServiceFactory() definition code for javax.print.StreamPrintServiceFactory()

public StreamPrintServiceFactory()
Method Detail

lookupStreamPrintServiceFactories sample code for javax.print.StreamPrintServiceFactory.lookupStreamPrintServiceFactories(javax.print.DocFlavor, java.lang.String) definition code for javax.print.StreamPrintServiceFactory.lookupStreamPrintServiceFactories(javax.print.DocFlavor, java.lang.String)

public static StreamPrintServiceFactory sample code for javax.print.StreamPrintServiceFactory definition code for javax.print.StreamPrintServiceFactory [] lookupStreamPrintServiceFactories(DocFlavor sample code for javax.print.DocFlavor definition code for javax.print.DocFlavor  flavor,
                                                                            String sample code for java.lang.String definition code for java.lang.String  outputMimeType)
Locates factories for print services that can be used with a print job to output a stream of data in the format specified by flavor. For example, the doc flavor is the document type that you want to create, not the flavor of the document before printing.

Although null is an acceptable value to use in the lookup of stream printing services, it's typical to search for a particular desired format, such as Postscript(TM).

Parameters:
flavor - of the input document type - null means match all types.
outputMimeType - representing the required output format, used to identify suitable stream printer factories. A value of null means match all formats.
Returns:
- matching factories for stream print service instance, empty if no suitable factories could be located.

getOutputFormat sample code for javax.print.StreamPrintServiceFactory.getOutputFormat() definition code for javax.print.StreamPrintServiceFactory.getOutputFormat()

public abstract String sample code for java.lang.String definition code for java.lang.String  getOutputFormat()
Queries the factory for the document format that is emitted by printers obtained from this factory.

Returns:
the output format described as a mime type.

getSupportedDocFlavors sample code for javax.print.StreamPrintServiceFactory.getSupportedDocFlavors() definition code for javax.print.StreamPrintServiceFactory.getSupportedDocFlavors()

public abstract DocFlavor sample code for javax.print.DocFlavor definition code for javax.print.DocFlavor [] getSupportedDocFlavors()
Queries the factory for the document flavors that can be accepted by printers obtained from this factory.

Returns:
array of supported doc flavors.

getPrintService sample code for javax.print.StreamPrintServiceFactory.getPrintService(java.io.OutputStream) definition code for javax.print.StreamPrintServiceFactory.getPrintService(java.io.OutputStream)

public abstract StreamPrintService sample code for javax.print.StreamPrintService definition code for javax.print.StreamPrintService  getPrintService(OutputStream sample code for java.io.OutputStream definition code for java.io.OutputStream  out)
Returns a StreamPrintService that can print to the specified output stream. The output stream is created and managed by the application. It is the application's responsibility to close the stream and to ensure that this Printer is not reused. The application should not close this stream until any print job created from the printer is complete. Doing so earlier may generate a PrinterException and an event indicating that the job failed.

Whereas a PrintService connected to a physical printer can be reused, a StreamPrintService connected to a stream cannot. The underlying StreamPrintService may be disposed by the print system with the dispose sample code for javax.print.StreamPrintService.dispose() definition code for javax.print.StreamPrintService.dispose() method before returning from the print sample code for javax.print.DocPrintJob.print(javax.print.Doc, javax.print.attribute.PrintRequestAttributeSet) definition code for javax.print.DocPrintJob.print(javax.print.Doc, javax.print.attribute.PrintRequestAttributeSet) method of DocPrintJob so that the print system knows this printer is no longer usable. This is equivalent to a physical printer going offline - permanently. Applications may supply a null print stream to create a queryable service. It is not valid to create a PrintJob for such a stream. Implementations which allocate resources on construction should examine the stream and may wish to only allocate resources if the stream is non-null.

Parameters:
out - destination stream for generated output.
Returns:
a PrintService which will generate the format specified by the DocFlavor supported by this Factory.