Source for javax.print.StreamPrintServiceFactory

   1: /* StreamPrintServiceFactory.java -- 
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.print;
  40: 
  41: import gnu.classpath.ServiceFactory;
  42: 
  43: import java.io.OutputStream;
  44: import java.util.Arrays;
  45: import java.util.HashSet;
  46: import java.util.Iterator;
  47: 
  48: /**
  49:  * <code>StreamPrintServiceFactory</code> provides a static method to lookup 
  50:  * registered factories to construct <code>StreamPrintService</code> instances.
  51:  * <p>
  52:  * <code>StreamPrintService</code> are used to print into a provided output 
  53:  * stream in the document format provided by the stream print service 
  54:  * implementation.
  55:  * </p><p>
  56:  * Implementations are located and loaded automatically through the SPI JAR 
  57:  * file specification. Therefore implementation classes must provide a default 
  58:  * constructor for instantiation.
  59:  * </p>
  60:  * 
  61:  * @author Wolfgang Baer (WBaer@gmx.de)
  62:  */
  63: public abstract class StreamPrintServiceFactory
  64: {   
  65:   /**
  66:    * Default public constructor.
  67:    * Used for automatic loading and instantiation through 
  68:    * the SPI jar file specification.
  69:    */
  70:   public StreamPrintServiceFactory()
  71:   {
  72:     // nothing to do
  73:   }
  74:   
  75:   /**
  76:    * Searches for matching factories providing stream print services that  
  77:    * support the printing of documents with the given document flavor into 
  78:    * the given output mime type.
  79:    * 
  80:    * @param flavor the document flavor needed, <code>null</code> doesn't 
  81:    * constrain the lookup result.
  82:    * @param outputMimeType the mime type needed, <code>null</code> doesn't 
  83:    * constrain the lookup result.
  84:    * 
  85:    * @return The matching <code>StreamPrintServiceFactory</code> instances.
  86:    */
  87:   public static StreamPrintServiceFactory[] lookupStreamPrintServiceFactories(
  88:     DocFlavor flavor, String outputMimeType)
  89:   {
  90:     HashSet set = new HashSet();
  91:     
  92:     Iterator it = 
  93:       ServiceFactory.lookupProviders(StreamPrintServiceFactory.class);
  94:     
  95:     while (it.hasNext())
  96:       {
  97:         StreamPrintServiceFactory tmp = (StreamPrintServiceFactory) it.next();
  98:         if (tmp.getOutputFormat().equals(outputMimeType)
  99:             && Arrays.asList(tmp.getSupportedDocFlavors()).contains(flavor))
 100:           set.add(tmp);          
 101:       }
 102:     
 103:     StreamPrintServiceFactory[] tmp = new StreamPrintServiceFactory[set.size()];
 104:     return (StreamPrintServiceFactory[]) set.toArray(tmp);  
 105:   } 
 106:   
 107:   /**
 108:    * Returns the output format supported by this factory.
 109:    * 
 110:    * @return The mime type of the output format as string representation.
 111:    */
 112:   public abstract String getOutputFormat();
 113:   
 114:   /**
 115:    * Returns the document flavors this factory supports as flavors
 116:    * for the input documents.
 117:    * 
 118:    * @return The array of supported document flavors.
 119:    */
 120:   public abstract DocFlavor[] getSupportedDocFlavors();
 121:   
 122:   /**
 123:    * Constructs a <code>StreamPrintService</code> which directs its output
 124:    * the given output stream.
 125:    * 
 126:    * @param out the output stream for the produced document.
 127:    * @return The constructed stream print service.
 128:    */
 129:   public abstract StreamPrintService getPrintService(OutputStream out);
 130: }