javax.print

Interface Doc

Known Implementing Classes:: SimpleDoc, SpooledDocument

public interface Doc

Doc specifies the interface for print services how to obtain the print data and document specific attributes for printing.

The print data is always passed to a DocPrintJob object as a Doc object which allows the print services to:

Determine the actual document format of the supplied print data. This is supplied as a DocFlavor object with the MIME type and the representation class of the print data.
Obtain the print data either in its representation class or depending on the document format through convenience methods as a Reader or an InputStream.
Obtain the document's attribute set specifying the attributes which apply to this document instance.

Every method of a Doc implementation has to return always the same object on every method call. Therefore if the print job consumes the print data via a stream or a reader object it can read only once the supplied print data. Implementations of this interface have to be thread safe.

Method Summary
`DocAttributeSet`	`getAttributes()` Returns the unmodifiable view of the attributes of this doc object.
`DocFlavor`	`getDocFlavor()` Returns the flavor of this doc objects print data.
`Object`	`getPrintData()` Returns the print data of this doc object.
`Reader`	`getReaderForText()` Returns a `Reader` object for extracting character print data from this document.
`InputStream`	`getStreamForBytes()` Returns an `InputStream` object for extracting byte print data from this document.

getAttributes

public DocAttributeSet getAttributes()

Returns the unmodifiable view of the attributes of this doc object.
The attributes of this doc's attributes set overrides attributes of the same category in the print job's attribute set. If an attribute is not available in this doc's attributes set or null is returned the attributes of the same category of the print job are used.
Returns:
The unmodifiable attributes set, or null.

getDocFlavor

public DocFlavor getDocFlavor()

Returns the flavor of this doc objects print data.
Returns:
The document flavor.

getPrintData

public Object getPrintData()
            throws IOException

Returns the print data of this doc object.
The returned object is an instance as described by the associated document flavor (DocFlavor.getRepresentationClassName()) and can be cast to this representation class.
Returns:
The print data in the representation class.
Throws:
IOException - if representation class is a stream and I/O exception occures.

getReaderForText

public Reader getReaderForText()
            throws IOException

Returns a Reader object for extracting character print data from this document.
This method is supported if the document flavor is of type:
char[]
java.lang.String
java.io.Reader
otherwise this method returns null.
Returns:
The Reader object, or null.
Throws:
IOException - if an error occurs.

getStreamForBytes

public InputStream getStreamForBytes()
            throws IOException

Returns an InputStream object for extracting byte print data from this document.
This method is supported if the document flavor is of type:
byte[]
java.io.InputStream
otherwise this method returns null.
Returns:
The InputStream object, or null.
Throws:
IOException - if an error occurs.

Doc.java -- Copyright (C) 2004, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About
Prev Class \| Next Class		Frames \| No Frames
Summary: Nested \| Field \| Method \| Constr	Detail: Nested \| Field \| Method \| Constr