FileDocCategorySizeDatePackage
StreamPrintServiceFactory.javaAPI DocJava SE 6 API7247Tue Jun 10 00:26:22 BST 2008javax.print

StreamPrintServiceFactory

public abstract class StreamPrintServiceFactory extends Object
A StreamPrintServiceFactory is the factory for {@link 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 {@link #lookupStreamPrintServiceFactories(DocFlavor, String)} method.

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

Fields Summary
Constructors Summary
Methods Summary
private static java.util.ArrayListgetAllFactories()

	synchronized (StreamPrintServiceFactory.class) {

	  ArrayList listOfFactories = getListOfFactories(); 
	    if (listOfFactories != null) {
		return listOfFactories;
	    } else {
		listOfFactories = initListOfFactories();
	    }

	    try {
		java.security.AccessController.doPrivileged(
		     new java.security.PrivilegedExceptionAction() {
                        public Object run() {
			    Iterator iterator =
				Service.providers(
				    StreamPrintServiceFactory.class);
			    ArrayList lof = getListOfFactories();
			    while (iterator.hasNext()) {
				try {
				    StreamPrintServiceFactory factory =
				 	(StreamPrintServiceFactory)
					           iterator.next();
				    lof.add(factory);
				}  catch (Exception e) {
				}
			    }
			    return null;
			}
		});
	    } catch (java.security.PrivilegedActionException e) {
	    }
	    return listOfFactories;
	}
    
private static java.util.ArrayListgetFactories(javax.print.DocFlavor flavor, java.lang.String outType)

	
        if (flavor == null && outType == null) {
            return getAllFactories();
        }

        ArrayList list = new ArrayList();
        Iterator iterator = getAllFactories().iterator();
        while (iterator.hasNext()) {
            StreamPrintServiceFactory factory =
                (StreamPrintServiceFactory)iterator.next();
	    if ((outType == null || 
		 outType.equalsIgnoreCase(factory.getOutputFormat())) &&
		(flavor == null || 
		 isMember(flavor, factory.getSupportedDocFlavors()))) {
                list.add(factory);
            }
        }

        return list;
    
private static java.util.ArrayListgetListOfFactories()

	return getServices().listOfFactories;
    
public abstract java.lang.StringgetOutputFormat()
Queries the factory for the document format that is emitted by printers obtained from this factory.

return
the output format described as a mime type.

public abstract javax.print.StreamPrintServicegetPrintService(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 {@link StreamPrintService#dispose() dispose} method before returning from the {@link DocPrintJob#print(Doc, javax.print.attribute.PrintRequestAttributeSet) print} 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.

param
out destination stream for generated output.
return
a PrintService which will generate the format specified by the DocFlavor supported by this Factory.

private static javax.print.StreamPrintServiceFactory$ServicesgetServices()

    

        
	Services services =
	    (Services)AppContext.getAppContext().get(Services.class);
	if (services == null) {
	    services = new Services();
	    AppContext.getAppContext().put(Services.class, services);
	}
	return services;	
    
public abstract javax.print.DocFlavor[]getSupportedDocFlavors()
Queries the factory for the document flavors that can be accepted by printers obtained from this factory.

return
array of supported doc flavors.

private static java.util.ArrayListinitListOfFactories()

	ArrayList listOfFactories = new ArrayList();
	getServices().listOfFactories = listOfFactories;
	return listOfFactories;
    
private static booleanisMember(javax.print.DocFlavor flavor, javax.print.DocFlavor[] flavors)

	for (int f=0; f<flavors.length; f++ ) {
	    if (flavor.equals(flavors[f])) {
		return true;
	    }
	}
	return false;
    
public static javax.print.StreamPrintServiceFactory[]lookupStreamPrintServiceFactories(javax.print.DocFlavor flavor, 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).

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

         
         ArrayList list = getFactories(flavor, outputMimeType);
	 return (StreamPrintServiceFactory[])
               (list.toArray(new StreamPrintServiceFactory[list.size()]));