SimpleDoc JDK 1.6)

Description

publicfinal class SimpleDoc

This class is an implementation of interface Doc that can be used in many common printing requests.

This class is an implementation of interface Doc that can be used in many common printing requests. It can handle all of the presently defined "pre-defined" doc flavors defined as static variables in the DocFlavor class.

In particular this class implements certain required semantics of the Doc specification as follows:

constructs a stream for the service if requested and appropriate.
ensures the same object is returned for each call on a method.
ensures multiple threads can access the Doc
performs some validation of that the data matches the doc flavor.

Clients who want to re-use the doc object in other jobs, or need a MultiDoc will not want to use this class.

If the print data is a stream, or a print job requests data as a stream, then SimpleDoc does not monitor if the service properly closes the stream after data transfer completion or job termination. Clients may prefer to use provide their own implementation of doc that adds a listener to monitor job completion and to validate that resources such as streams are freed (ie closed).

See also:

Constructors

public SimpleDoc (Object printData, DocFlavor flavor, DocAttributeSet attributes)

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

Constructs a SimpleDoc with the specified
print data, doc flavor and doc attribute set.
Parameters:
- printData - the print data object
- flavor - the DocFlavor object
- attributes - a DocAttributeSet, which can be null
Throws:
- IllegalArgumentException - if flavor or printData is null, or the printData does not correspond to the specified doc flavor--for example, the data is not of the type specified as the representation in the DocFlavor.

Methods

Hide/Show inherited methods

public DocAttributeSet getAttributes () [Specified in Doc]

Obtains the set of printing attributes for this doc object.

public DocFlavor getDocFlavor () [Specified in Doc]

Determines the doc flavor in which this doc object will supply its piece of print data.

public Object getPrintData () throws IOException [Specified in Doc]

public Reader getReaderForText () throws IOException [Specified in Doc]

Obtains a reader for extracting character print data from this doc.

Obtains a reader for extracting character print data from this doc. The Doc implementation is required to support this method if the DocFlavor has one of the following print data representation classes, and return null otherwise:

char[]
java.lang.String
java.io.Reader

The doc's print data representation object is used to construct and return a Reader for reading the print data as a stream of characters from the print data representation object. However, if the print data representation object is itself a Reader then the print data representation object is simply returned.

Returns: a Reader for reading the print data characters from this doc. If a reader cannot be provided because this doc does not meet the criteria stated above, null is returned.
Throws:
- IOException - if there was an I/O error while creating the reader.

public InputStream getStreamForBytes () throws IOException [Specified in Doc]

Obtains an input stream for extracting byte print data from this doc.

Obtains an input stream for extracting byte print data from this doc. The Doc implementation is required to support this method if the DocFlavor has one of the following print data representation classes; otherwise this method returns null:

byte[]
java.io.InputStream

The doc's print data representation object is obtained. Then, an input stream for reading the print data from the print data representation object as a stream of bytes is created and returned. However, if the print data representation object is itself an input stream then the print data representation object is simply returned.

Returns: an InputStream for reading the print data bytes from this doc. If an input stream cannot be provided because this doc does not meet the criteria stated above, null is returned.
Throws:
- IOException - if there was an I/O error while creating the input stream.