StreamPrintServiceFactory is the factory for
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 ServiceLoader facility.
Applications locate instances of this class by calling the
lookupStreamPrintServiceFactories(DocFlavor, String) method.
Applications can use a StreamPrintService obtained from a factory in
place of a PrintService which represents a physical printer device.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor for subclasses to call. -
Method Summary
Modifier and TypeMethodDescriptionabstract StringQueries the factory for the document format that is emitted by printers obtained from this factory.abstract StreamPrintServiceReturns aStreamPrintServicethat can print to the specified output stream.abstract DocFlavor[]Queries the factory for the document flavors that can be accepted by printers obtained from this factory.static StreamPrintServiceFactory[]lookupStreamPrintServiceFactories(DocFlavor flavor, 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 byoutputMimeType.
-
Constructor Details
-
StreamPrintServiceFactory
protected StreamPrintServiceFactory()Constructor for subclasses to call.
-
-
Method Details
-
lookupStreamPrintServiceFactories
public static StreamPrintServiceFactory[] lookupStreamPrintServiceFactories(DocFlavor flavor, 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 byoutputMimeType.The
outputMimeTypeparameter describes the document type that you want to create, whereas theflavorparameter describes the format in which the input data will be provided by the application to theStreamPrintService.Although
nullis 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 -nullmeans match all typesoutputMimeType- representing the required output format, used to identify suitable stream printer factories. A value ofnullmeans match all formats.- Returns:
- matching factories for stream print service instance, empty if no suitable factories could be located
-
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
Queries the factory for the document flavors that can be accepted by printers obtained from this factory.- Returns:
- array of supported doc flavors
-
getPrintService
Returns aStreamPrintServicethat 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 thisPrinteris not reused. The application should not close this stream until any print job created from the printer is complete. Doing so earlier may generate aPrinterExceptionand an event indicating that the job failed.Whereas a
PrintServiceconnected to a physical printer can be reused, aStreamPrintServiceconnected to a stream cannot. The underlyingStreamPrintServicemay be disposed by the print system with thedisposemethod before returning from theprintmethod ofDocPrintJobso that the print system knows this printer is no longer usable. This is equivalent to a physical printer going offline - permanently. Applications may supply anullprint stream to create a queryable service. It is not valid to create aPrintJobfor such a stream. Implementations which allocate resources on construction should examine the stream and may wish to only allocate resources if the stream isnon-null.- Parameters:
out- destination stream for generated output- Returns:
- a
PrintServicewhich will generate the format specified by theDocFlavorsupported by this factory
-