- java.lang.Object
- 
- javax.print.SimpleDoc
 
- 
- All Implemented Interfaces:
- Doc
 
 public final class SimpleDoc extends Object implements Doc This class is an implementation of interfaceDocthat 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 theDocFlavorclass.In particular this class implements certain required semantics of the Docspecification 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.
 MultiDocwill not want to use this class.If the print data is a stream, or a print job requests data as a stream, then SimpleDocdoes 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 SummaryConstructors Constructor Description SimpleDoc(Object printData, DocFlavor flavor, DocAttributeSet attributes)Constructs aSimpleDocwith the specified print data, doc flavor and doc attribute set.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description DocAttributeSetgetAttributes()Obtains the set of printing attributes for this doc object.DocFlavorgetDocFlavor()Determines the doc flavor in which this doc object will supply its piece of print data.ObjectgetPrintData()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.ReadergetReaderForText()Obtains a reader for extracting character print data from this doc.InputStreamgetStreamForBytes()Obtains an input stream for extracting byte print data from this doc.
 
- 
- 
- 
Constructor Detail- 
SimpleDocpublic SimpleDoc(Object printData, DocFlavor flavor, DocAttributeSet attributes) Constructs aSimpleDocwith the specified print data, doc flavor and doc attribute set.- Parameters:
- printData- the print data object
- flavor- the- DocFlavorobject
- attributes- a- DocAttributeSet, which can be- null
- Throws:
- IllegalArgumentException- if- flavoror- printDatais- null, or the- printDatadoes not correspond to the specified doc flavor--for example, the data is not of the type specified as the representation in the- DocFlavor
 
 
- 
 - 
Method Detail- 
getDocFlavorpublic DocFlavor getDocFlavor() Determines the doc flavor in which this doc object will supply its piece of print data.- Specified by:
- getDocFlavorin interface- Doc
- Returns:
- doc flavor
 
 - 
getAttributespublic 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 ifnullis 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.- Specified by:
- getAttributesin interface- Doc
- Returns:
- unmodifiable set of printing attributes for this doc, or
         nullto obtain all attribute values from the job's attribute set
 
 - 
getPrintDatapublic Object getPrintData() throws IOException 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. ThegetPrintData()method returns an instance of the representation class whose name is given bygetDocFlavor().getRepresentationClassName(), and the return value can be cast from classObjectto that representation class.- Specified by:
- getPrintDatain interface- Doc
- Returns:
- print data representation object
- Throws:
- IOException- if the representation class is a stream and there was an I/O error while constructing the stream
 
 - 
getReaderForTextpublic Reader getReaderForText() throws IOException Obtains a reader for extracting character print data from this doc. TheDocimplementation is required to support this method if theDocFlavorhas one of the following print data representation classes, and returnnullotherwise:- char[]
- java.lang.String
- java.io.Reader
 Readerfor reading the print data as a stream of characters from the print data representation object. However, if the print data representation object is itself aReaderthen the print data representation object is simply returned.- Specified by:
- getReaderForTextin interface- Doc
- Returns:
- a Readerfor reading the print data characters from this doc. If a reader cannot be provided because this doc does not meet the criteria stated above,nullis returned.
- Throws:
- IOException- if there was an I/O error while creating the reader
 
 - 
getStreamForBytespublic InputStream getStreamForBytes() throws IOException Obtains an input stream for extracting byte print data from this doc. TheDocimplementation is required to support this method if theDocFlavorhas one of the following print data representation classes; otherwise this method returnsnull:- byte[]
- java.io.InputStream
 - Specified by:
- getStreamForBytesin interface- Doc
- Returns:
- an InputStreamfor 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,nullis returned.
- Throws:
- IOException- if there was an I/O error while creating the input stream
 
 
- 
 
-