Source for javax.print.Doc

   1: /* Doc.java --
   2:    Copyright (C) 2004 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: import java.io.InputStream;
  43: import java.io.Reader;
  44: 
  45: import javax.print.attribute.DocAttributeSet;
  46: 
  47: /**
  48:  * @author Michael Koch (konqueror@gmx.de)
  49:  */
  50: public interface Doc
  51: {
  52:   /**
  53:    * Returns a set of attributes applying to this document.
  54:    * 
  55:    * @return the attributes
  56:    */
  57:   DocAttributeSet getAttributes();
  58: 
  59:   /**
  60:    * Returns the flavor in which this document will provide its print data.
  61:    *  
  62:    * @return the document flavor for printing
  63:    */
  64:   DocFlavor getDocFlavor();
  65: 
  66:   /**
  67:    * Returns the print data of this document represented in a format that supports
  68:    * the document flavor.
  69:    * 
  70:    * @return the print data
  71:    * 
  72:    * @throws IOException if an error occurs
  73:    */
  74:   Object getPrintData() throws IOException;
  75: 
  76:   /**
  77:    * Returns a <code>Reader</code> object for extracting character print data
  78:    * from this document.
  79:    * 
  80:    * @return the <code>Reader</code> object
  81:    * 
  82:    * @throws IOException if an error occurs
  83:    */
  84:   Reader getReaderForText() throws IOException;
  85: 
  86:   /**
  87:    * Returns an <code>InputStream</code> object for extracting byte print data
  88:    * from this document.
  89:    * 
  90:    * @return the <code>InputStream</code> object
  91:    * 
  92:    * @throws IOException if an error occurs
  93:    */
  94:   InputStream getStreamForBytes() throws IOException;