Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.print

Class SimpleDoc

Implemented Interfaces:
Doc
public final class SimpleDoc
extends 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

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

Method Summary

DocAttributeSet
getAttributes()
Returns the unmodifiable view of the attributes of this doc object.
DocFlavor
getDocFlavor()
Returns the flavor of this doc objects print data.
Object
getPrintData()
Returns the print data of this doc object.
Reader
getReaderForText()
Returns a Reader object for extracting character print data from this document.
InputStream
getStreamForBytes()
Returns an InputStream object for extracting byte print data from this document.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SimpleDoc

public SimpleDoc(Object printData,
                 DocFlavor flavor,
                 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:
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 Details

getAttributes

public 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 Object getPrintData()
            throws 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:
IOException - if representation class is a stream and I/O exception occures.

getReaderForText

public Reader getReaderForText()
            throws 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:
IOException - if an error occurs.

getStreamForBytes

public InputStream getStreamForBytes()
            throws 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:
IOException - if an error occurs.
SimpleDoc.java -- Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About