public final class SimpleDoc extends Object implements Doc
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:
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).
| Constructor and Description |
|---|
SimpleDoc(Object printData,
DocFlavor flavor,
DocAttributeSet attributes)
Constructs a
SimpleDoc with the specified
print data, doc flavor and doc attribute set. |
| Modifier and Type | Method and Description |
|---|---|
DocAttributeSet |
getAttributes()
Obtains the set of printing attributes for this doc object.
|
DocFlavor |
getDocFlavor()
Determines the doc flavor in which this doc object will supply its
piece of print data.
|
Object |
getPrintData()
Obtains the print data representation object that contains this doc
object's piece of print data in the format corresponding to the
supported doc flavor.
|
Reader |
getReaderForText()
Obtains a reader for extracting character print data from this doc.
|
InputStream |
getStreamForBytes()
Obtains an input stream for extracting byte print data from
this doc.
|
public SimpleDoc(Object printData, DocFlavor flavor, DocAttributeSet attributes)
SimpleDoc with the specified
print data, doc flavor and doc attribute set.printData - the print data objectflavor - the DocFlavor objectattributes - a DocAttributeSet, which can
be nullIllegalArgumentException - 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.public DocFlavor getDocFlavor()
getDocFlavor in interface Docpublic DocAttributeSet getAttributes()
getAttributes in interface Docpublic Object getPrintData() throws IOException
DocgetPrintData() method returns an instance of
the representation class whose name is given by getDocFlavor().getRepresentationClassName(), and the return value can be cast
from class Object to that representation class.getPrintData in interface DocIOException - Thrown if the representation class is a stream and there was an I/O
error while constructing the stream.public Reader getReaderForText() throws IOException
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
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.
getReaderForText in interface DocReader 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.IOException - if there was an I/O error while creating
the reader.public InputStream getStreamForBytes() throws IOException
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
getStreamForBytes in interface DocInputStream 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.IOException - if there was an I/O error while creating the input stream. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.