javax.print
Interface Doc

All Known Implementing Classes:
SimpleDoc

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:

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.
 

Method Detail

getAttributes

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

DocFlavor getDocFlavor()
Returns the flavor of this doc objects print data.

Returns:
The document flavor.

getPrintData

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

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:

otherwise this method returns null.

Returns:
The Reader object, or null.
Throws:
IOException - if an error occurs.

getStreamForBytes

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:

otherwise this method returns null.

Returns:
The InputStream object, or null.
Throws:
IOException - if an error occurs.