diff options
Diffstat (limited to 'libjava/classpath/javax/print/MultiDocPrintJob.java')
-rw-r--r-- | libjava/classpath/javax/print/MultiDocPrintJob.java | 27 |
1 files changed, 22 insertions, 5 deletions
diff --git a/libjava/classpath/javax/print/MultiDocPrintJob.java b/libjava/classpath/javax/print/MultiDocPrintJob.java index b096769b05a..36089b5d070 100644 --- a/libjava/classpath/javax/print/MultiDocPrintJob.java +++ b/libjava/classpath/javax/print/MultiDocPrintJob.java @@ -1,5 +1,5 @@ /* MultiDocPrintJob.java -- - Copyright (C) 2004 Free Software Foundation, Inc. + Copyright (C) 2004, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -42,17 +42,34 @@ import javax.print.attribute.PrintRequestAttributeSet; /** + * <code>MultiDocPrintJob</code> represents a print job which supports + * printing of multiple documents as one print job. + * <p> + * An instance can be obtained from every <code>MultiDocPrintService</code> + * available by calling the + * {@link javax.print.MultiDocPrintService#createMultiDocPrintJob()} method. + * A print job is bound to the print service it is created from. + * </p> + * * @author Michael Koch (konqueror@gmx.de) */ public interface MultiDocPrintJob extends DocPrintJob { /** - * Request a print of a <code>MultiDoc</code> object. + * Prints the documents supplied in the given <code>MultiDoc</code> object + * as one print job with the given printing attributes. * - * @param multiDoc the document to print - * @param attributes the printing attributes to apply + * @param multiDoc the documents to print. Every document must have a + * flavor supported by the bound print service. + * @param attributes the printing attributes to apply to the print job. If + * <code>null</code> the default attribute values will be used. * - * @throws PrintExeption if an error occurs + * @throws PrintException if an error occurs. The thrown exception may + * implement refining print exception interface to provide more detail of + * the error. + * + * @see FlavorException + * @see AttributeException */ void print(MultiDoc multiDoc, PrintRequestAttributeSet attributes) throws PrintException; |