SimpleDocpublic final class SimpleDoc extends Object implements DocThis 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). |
| Fields Summary |
|---|
| private DocFlavor | flavor | | private DocAttributeSet | attributes | | private Object | printData | | private Reader | reader | | private InputStream | inStream |
| Constructors Summary |
|---|
public SimpleDoc(Object printData, DocFlavor flavor, DocAttributeSet attributes)Constructs a SimpleDoc with the specified
print data, doc flavor and doc attribute set.
if (flavor == null || printData == null) {
throw new IllegalArgumentException("null argument(s)");
}
Class repClass = null;
try {
repClass = Class.forName(flavor.getRepresentationClassName());
} catch (Throwable e) {
throw new IllegalArgumentException("unknown representation class");
}
if (!repClass.isInstance(printData)) {
throw new IllegalArgumentException("data is not of declared type");
}
this.flavor = flavor;
if (attributes != null) {
this.attributes = AttributeSetUtilities.unmodifiableView(attributes);
}
this.printData = printData;
|
| Methods Summary |
|---|
| public javax.print.attribute.DocAttributeSet | getAttributes()Obtains the set of printing attributes for this doc object. If the
returned attribute set includes an instance of a particular attribute
X, the printer must use that attribute value for this doc,
overriding any value of attribute X in the job's attribute set.
If the returned attribute set does not include an instance
of a particular attribute X or if null is returned, the printer
must consult the job's attribute set to obtain the value for
attribute X, and if not found there, the printer must use an
implementation-dependent default value. The returned attribute set is
unmodifiable.
return attributes;
| | public javax.print.DocFlavor | getDocFlavor()Determines the doc flavor in which this doc object will supply its
piece of print data.
return flavor;
| | public java.lang.Object | getPrintData()
return printData;
| | public java.io.Reader | getReaderForText()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.
if (printData instanceof Reader) {
return (Reader)printData;
}
synchronized (this) {
if (reader != null) {
return reader;
}
if (printData instanceof char[]) {
reader = new CharArrayReader((char[])printData);
}
else if (printData instanceof String) {
reader = new StringReader((String)printData);
}
}
return reader;
| | public java.io.InputStream | getStreamForBytes()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.
if (printData instanceof InputStream) {
return (InputStream)printData;
}
synchronized (this) {
if (inStream != null) {
return inStream;
}
if (printData instanceof byte[]) {
inStream = new ByteArrayInputStream((byte[])printData);
}
}
return inStream;
|
|
