javax.print

Class SimpleDoc

java.lang.Object

javax.print.SimpleDoc

All Implemented Interfaces:

Doc

public final class SimpleDoc
extends java.lang.Object
implements Doc

Simple implementation of the Doc interface capable of handling the predefined document flavors of DocFlavor.

This implementation can construct a reader or stream for the service from the print data and ensures that always the same object is returned on each method call. It does simple checks that the supplied data matches the specified flavor of the doc object and supports thread safe access.

Constructor Summary

Constructors

Constructor and Description
SimpleDoc(java.lang.Object printData, DocFlavor flavor, javax.print.attribute.DocAttributeSet attributes) Constructs a SimpleDoc with the specified print data, doc flavor and doc attribute set.

Method Summary

Methods

Modifier and Type	Method and Description
javax.print.attribute.DocAttributeSet	getAttributes() Returns the unmodifiable view of the attributes of this doc object.
DocFlavor	getDocFlavor() Returns the flavor of this doc objects print data.
java.lang.Object	getPrintData() Returns the print data of this doc object.
java.io.Reader	getReaderForText() Returns a Reader object for extracting character print data from this document.
java.io.InputStream	getStreamForBytes() Returns an InputStream object for extracting byte print data from this document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleDoc

public SimpleDoc(java.lang.Object printData,
         DocFlavor flavor,
         javax.print.attribute.DocAttributeSet attributes)

Constructs a SimpleDoc with the specified print data, doc flavor and doc attribute set.

Parameters:

printData - the object with the data to print.

flavor - the document flavor of the print data.

attributes - the attributes of the doc (may be null).

Throws:

java.lang.IllegalArgumentException - if either printData or flavor are null, or the print data is not supplied in the document format specified by the given flavor object.

Method Detail

getAttributes

public javax.print.attribute.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.

Specified by:

getAttributes in interface Doc

Returns:

The unmodifiable attributes set, or null.

getDocFlavor

public DocFlavor getDocFlavor()

Returns the flavor of this doc objects print data.

Specified by:

getDocFlavor in interface Doc

Returns:

The document flavor.

getPrintData

public java.lang.Object getPrintData()
                              throws java.io.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.

Specified by:

getPrintData in interface Doc

Returns:

The print data in the representation class.

Throws:

java.io.IOException - if representation class is a stream and I/O exception occures.

getReaderForText

public java.io.Reader getReaderForText()
                                throws java.io.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.

Specified by:

getReaderForText in interface Doc

Returns:

The Reader object, or null.

Throws:

java.io.IOException - if an error occurs.

getStreamForBytes

public java.io.InputStream getStreamForBytes()
                                      throws java.io.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.

Specified by:

getStreamForBytes in interface Doc

Returns:

The InputStream object, or null.

Throws:

java.io.IOException - if an error occurs.