--- old/src/java.desktop/share/classes/javax/print/attribute/standard/MultipleDocumentHandling.java 2017-08-11 15:12:50.000000000 -0700 +++ new/src/java.desktop/share/classes/javax/print/attribute/standard/MultipleDocumentHandling.java 2017-08-11 15:12:50.000000000 -0700 @@ -22,178 +22,162 @@ * or visit www.oracle.com if you need additional information or have any * questions. */ + package javax.print.attribute.standard; import javax.print.attribute.Attribute; import javax.print.attribute.EnumSyntax; -import javax.print.attribute.PrintRequestAttribute; import javax.print.attribute.PrintJobAttribute; +import javax.print.attribute.PrintRequestAttribute; /** - * Class MultipleDocumentHandling is a printing attribute class, an enumeration, - * that controls finishing operations and the placement of one or more - * print-stream pages into impressions and onto media sheets. When the value of - * the {@link Copies Copies} attribute exceeds 1, MultipleDocumentHandling also - * controls the order in which the copies that result from processing the - * documents are produced. This attribute is relevant only for a multidoc print - * job consisting of two or more individual docs. - *

- * Briefly, MultipleDocumentHandling determines the relationship between the - * multiple input (electronic) documents fed into a multidoc print job and the - * output (physical) document or documents produced by the multidoc print job. + * Class {@code MultipleDocumentHandling} is a printing attribute class, an + * enumeration, that controls finishing operations and the placement of one or + * more print-stream pages into impressions and onto media sheets. When the + * value of the {@link Copies Copies} attribute exceeds 1, + * {@code MultipleDocumentHandling} also controls the order in which the copies + * that result from processing the documents are produced. This attribute is + * relevant only for a multidoc print job consisting of two or more individual + * docs. + *

+ * Briefly, {@code MultipleDocumentHandling} determines the relationship between + * the multiple input (electronic) documents fed into a multidoc print job and + * the output (physical) document or documents produced by the multidoc print + * job. * There are two possibilities: - *

- *

- * In the detailed explanations below, if "{@code a}" represents an - * instance of document data, then the result of processing the data in - * document "{@code a}" is a sequence of media sheets represented by - * "{@code a(*)}". - *

- * The standard MultipleDocumentHandling values are: - *

- *

- * SINGLE_DOCUMENT is the same as SEPARATE_DOCUMENTS_COLLATED_COPIES with - * respect to ordering of print-stream pages, but not media sheet generation, - * since SINGLE_DOCUMENT will put the first page of the next document on the - * back side of a sheet if an odd number of pages have been produced so far - * for the job, while SEPARATE_DOCUMENTS_COLLATED_COPIES always forces the + *

+ * In the detailed explanations below, if "{@code a}" represents an instance of + * document data, then the result of processing the data in document "{@code a}" + * is a sequence of media sheets represented by "{@code a(*)}". + *

+ * The standard {@code MultipleDocumentHandling} values are: + *

+ *

+ * {@code SINGLE_DOCUMENT} is the same as + * {@code SEPARATE_DOCUMENTS_COLLATED_COPIES} with respect to ordering of + * print-stream pages, but not media sheet generation, since + * {@code SINGLE_DOCUMENT} will put the first page of the next document on the + * back side of a sheet if an odd number of pages have been produced so far for + * the job, while {@code SEPARATE_DOCUMENTS_COLLATED_COPIES} always forces the * next document or document copy on to a new sheet. - *

+ *

* In addition, if a {@link Finishings Finishings} attribute of * {@link Finishings#STAPLE STAPLE} is specified, then: - *

- *

- * Note: None of these values provide means to produce uncollated - * sheets within a document, i.e., where multiple copies of sheet n - * are produced before sheet n+1 of the same document. - * To specify that, see the {@link SheetCollate SheetCollate} attribute. - *

- * IPP Compatibility: The category name returned by - * {@code getName()} is the IPP attribute name. The enumeration's - * integer value is the IPP enum value. The {@code toString()} method - * returns the IPP string representation of the attribute value. - * - * @see Copies - * @see Finishings - * @see NumberUp - * @see PageRanges - * @see SheetCollate - * @see Sides - * - * @author David Mendenhall - * @author Alan Kaminsky + *

+ * Note: None of these values provide means to produce uncollated sheets + * within a document, i.e., where multiple copies of sheet n are produced + * before sheet n+1 of the same document. To specify that, see the + * {@link SheetCollate SheetCollate} attribute. + *

+ * IPP Compatibility: The category name returned by {@code getName()} is + * the IPP attribute name. The enumeration's integer value is the IPP enum + * value. The {@code toString()} method returns the IPP string representation of + * the attribute value. + * + * @author David Mendenhall + * @author Alan Kaminsky + * @see Copies + * @see Finishings + * @see NumberUp + * @see PageRanges + * @see SheetCollate + * @see Sides */ public class MultipleDocumentHandling extends EnumSyntax implements PrintRequestAttribute, PrintJobAttribute { + /** + * Use serialVersionUID from JDK 1.4 for interoperability. + */ private static final long serialVersionUID = 8098326460746413466L; - /** - * Single document -- see above for further - * information. + * Single document -- see above for further information. */ public static final MultipleDocumentHandling SINGLE_DOCUMENT = new MultipleDocumentHandling (0); /** * Separate documents uncollated copies -- see above for - * further information. + * further information. */ public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_UNCOLLATED_COPIES = new MultipleDocumentHandling (1); /** * Separate documents collated copies -- see above for - * further information. + * further information. */ public static final MultipleDocumentHandling SEPARATE_DOCUMENTS_COLLATED_COPIES = new MultipleDocumentHandling (2); /** - * Single document new sheet -- see above for - * further information. + * Single document new sheet -- see above for further + * information. */ public static final MultipleDocumentHandling SINGLE_DOCUMENT_NEW_SHEET = new MultipleDocumentHandling (3); @@ -203,12 +187,15 @@ * Construct a new multiple document handling enumeration value with the * given integer value. * - * @param value Integer value. + * @param value Integer value */ protected MultipleDocumentHandling(int value) { super (value); } + /** + * The string table for class {@code MultipleDocumentHandling}. + */ private static final String[] myStringTable = { "single-document", "separate-documents-uncollated-copies", @@ -216,6 +203,9 @@ "single-document-new-sheet" }; + /** + * The enumeration value table for class {@code MultipleDocumentHandling}. + */ private static final MultipleDocumentHandling[] myEnumValueTable = { SINGLE_DOCUMENT, SEPARATE_DOCUMENTS_UNCOLLATED_COPIES, @@ -224,14 +214,15 @@ }; /** - * Returns the string table for class MultipleDocumentHandling. + * Returns the string table for class {@code MultipleDocumentHandling}. */ protected String[] getStringTable() { return myStringTable.clone(); } /** - * Returns the enumeration value table for class MultipleDocumentHandling. + * Returns the enumeration value table for class + * {@code MultipleDocumentHandling}. */ protected EnumSyntax[] getEnumValueTable() { return (EnumSyntax[])myEnumValueTable.clone(); @@ -240,12 +231,13 @@ /** * Get the printing attribute class which is to be used as the "category" * for this printing attribute value. - *

- * For class MultipleDocumentHandling and any vendor-defined subclasses, - * the category is class MultipleDocumentHandling itself. + *

+ * For class {@code MultipleDocumentHandling} and any vendor-defined + * subclasses, the category is class {@code MultipleDocumentHandling} + * itself. * - * @return Printing attribute class (category), an instance of class - * {@link java.lang.Class java.lang.Class}. + * @return printing attribute class (category), an instance of class + * {@link Class java.lang.Class} */ public final Class getCategory() { return MultipleDocumentHandling.class; @@ -254,14 +246,13 @@ /** * Get the name of the category of which this attribute value is an * instance. - *

- * For class MultipleDocumentHandling and any vendor-defined subclasses, - * the category name is {@code "multiple-document-handling"}. + *

+ * For class {@code MultipleDocumentHandling} and any vendor-defined + * subclasses, the category name is {@code "multiple-document-handling"}. * - * @return Attribute category name. + * @return attribute category name */ public final String getName() { return "multiple-document-handling"; } - }