Source for javax.print.MultiDoc

   1: /* MultiDoc.java --
   2:    Copyright (C) 2004, 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 java.io.IOException;
  42: 
  43: 
  44: /**
  45:  * <code>MultiDoc</code> defines the interface for objects providing multiple
  46:  * documents for use in a print job.
  47:  * <p>
  48:  * Implementations of this interface are used to pass multiple documents, to be
  49:  * printed as one print job, to the <code>MultiDocPrintJob</code> instance.  
  50:  * </p><p>
  51:  * There exists no implementation of this interface in the Java Print Service 
  52:  * API. Implementors may assume the following usage in print jobs and the needed
  53:  * behaviour for implementations: The print job fetches the single documents via 
  54:  * iteration by consecutive calls of the {@link #getDoc()} method to obtain the 
  55:  * current document follwing calls of the {@link #next()} method to get the next 
  56:  * multidoc object for the next <code>getDoc()</code> method call (if returned
  57:  * multidoc object is not <code>null</code>). The print service will fetch the 
  58:  * document object and then retrieve the print data from the document before it 
  59:  * proceeds with the next call for the next MultiDoc object in the sequence.
  60:  * </p><p>
  61:  * Implementations of this interface have to be multiple thread-safe.
  62:  * </p>
  63:  * 
  64:  * @author Michael Koch (konqueror@gmx.de)
  65:  */
  66: public interface MultiDoc
  67: {
  68:   /**
  69:    * Returns the current document.
  70:    * 
  71:    * @return The current document.
  72:    * 
  73:    * @throws IOException if an error occurs
  74:    */
  75:   Doc getDoc() throws IOException;
  76: 
  77:   /**
  78:    * Returns the next <code>MultiDoc</code> object that contains the
  79:    * next document for retrieval.
  80:    * 
  81:    * @return The next <code>MultiDoc</code> object, or <code>null</code>
  82:    * if no more documents are available.
  83:    * 
  84:    * @throws IOException if an error occurs
  85:    */
  86:   MultiDoc next() throws IOException;