author | serb |
Thu, 31 Aug 2017 15:47:34 -0700 | |
changeset 47196 | a3211bb4daff |
parent 45025 | 9ad3afa82b5e |
permissions | -rw-r--r-- |
2 | 1 |
/* |
45025 | 2 |
* Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
47196 | 25 |
|
2 | 26 |
package javax.print.attribute.standard; |
27 |
||
28 |
import javax.print.attribute.Attribute; |
|
29 |
import javax.print.attribute.EnumSyntax; |
|
47196 | 30 |
import javax.print.attribute.PrintJobAttribute; |
2 | 31 |
import javax.print.attribute.PrintRequestAttribute; |
32 |
||
33 |
/** |
|
47196 | 34 |
* Class {@code MultipleDocumentHandling} is a printing attribute class, an |
35 |
* enumeration, that controls finishing operations and the placement of one or |
|
36 |
* more print-stream pages into impressions and onto media sheets. When the |
|
37 |
* value of the {@link Copies Copies} attribute exceeds 1, |
|
38 |
* {@code MultipleDocumentHandling} also controls the order in which the copies |
|
39 |
* that result from processing the documents are produced. This attribute is |
|
40 |
* relevant only for a multidoc print job consisting of two or more individual |
|
41 |
* docs. |
|
42 |
* <p> |
|
43 |
* Briefly, {@code MultipleDocumentHandling} determines the relationship between |
|
44 |
* the multiple input (electronic) documents fed into a multidoc print job and |
|
45 |
* the output (physical) document or documents produced by the multidoc print |
|
46 |
* job. |
|
2 | 47 |
* There are two possibilities: |
47196 | 48 |
* <ul> |
49 |
* <li>The multiple input documents are combined into a single output |
|
50 |
* document. Finishing operations ({@link Finishings Finishings}), are |
|
51 |
* performed on this single output document. The {@link Copies Copies} |
|
52 |
* attribute tells how many copies of this single output document to produce. |
|
53 |
* The {@code MultipleDocumentHandling} values {@code SINGLE_DOCUMENT} and |
|
54 |
* {@code SINGLE_DOCUMENT_NEW_SHEET} specify two variations of this |
|
55 |
* possibility. |
|
56 |
* <li>The multiple input documents remain separate output documents. |
|
57 |
* Finishing operations ({@link Finishings Finishings}), are performed on each |
|
58 |
* output document separately. The {@link Copies Copies} attribute tells how |
|
59 |
* many copies of each separate output document to produce. The |
|
60 |
* {@code MultipleDocumentHandling} values |
|
61 |
* {@code SEPARATE_DOCUMENTS_UNCOLLATED_COPIES} and |
|
62 |
* {@code SEPARATE_DOCUMENTS_COLLATED_COPIES} specify two variations of this |
|
63 |
* possibility. |
|
64 |
* </ul> |
|
65 |
* In the detailed explanations below, if "{@code a}" represents an instance of |
|
66 |
* document data, then the result of processing the data in document "{@code a}" |
|
67 |
* is a sequence of media sheets represented by "{@code a(*)}". |
|
68 |
* <p> |
|
69 |
* The standard {@code MultipleDocumentHandling} values are: |
|
70 |
* <ul> |
|
71 |
* <li><a id="sdfi"></a>{@link #SINGLE_DOCUMENT <b>SINGLE_DOCUMENT</b>}. If a |
|
72 |
* print job has multiple documents -- say, the document data is called |
|
73 |
* {@code a} and {@code b} -- then the result of processing all the document |
|
74 |
* data ({@code a} and then {@code b}) must be treated as a single sequence of |
|
75 |
* media sheets for finishing operations; that is, finishing would be |
|
76 |
* performed on the concatenation of the sequences {@code a(*),b(*)}. The |
|
77 |
* printer must not force the data in each document instance to be formatted |
|
78 |
* onto a new print-stream page, nor to start a new impression on a new media |
|
79 |
* sheet. If more than one copy is made, the ordering of the sets of media |
|
80 |
* sheets resulting from processing the document data must be |
|
81 |
* {@code a(*),b(*),a(*),b(*),...}, and the printer object must force each |
|
82 |
* copy ({@code a(*),b(*)}) to start on a new media sheet. |
|
83 |
* <li><a id="sducfi"></a>{@link #SEPARATE_DOCUMENTS_UNCOLLATED_COPIES |
|
84 |
* <b>SEPARATE_DOCUMENTS_UNCOLLATED_COPIES</b>}. If a print job has multiple |
|
85 |
* documents -- say, the document data is called {@code a} and {@code b} -- |
|
86 |
* then the result of processing the data in each document instance must be |
|
87 |
* treated as a single sequence of media sheets for finishing operations; that |
|
88 |
* is, the sets {@code a(*)} and {@code b(*)} would each be finished |
|
89 |
* separately. The printer must force each copy of the result of processing |
|
90 |
* the data in a single document to start on a new media sheet. If more than |
|
91 |
* one copy is made, the ordering of the sets of media sheets resulting from |
|
92 |
* processing the document data must be {@code a(*),a(*),...,b(*),b(*)...}. |
|
93 |
* <li><a id="sdccfi"></a>{@link #SEPARATE_DOCUMENTS_COLLATED_COPIES |
|
94 |
* <b>SEPARATE_DOCUMENTS_COLLATED_COPIES</b>}. If a print job has multiple |
|
95 |
* documents -- say, the document data is called {@code a} and {@code b} -- |
|
96 |
* then the result of processing the data in each document instance must be |
|
97 |
* treated as a single sequence of media sheets for finishing operations; that |
|
98 |
* is, the sets {@code a(*)} and {@code b(*)} would each be finished |
|
99 |
* separately. The printer must force each copy of the result of processing |
|
100 |
* the data in a single document to start on a new media sheet. If more than |
|
101 |
* one copy is made, the ordering of the sets of media sheets resulting from |
|
102 |
* processing the document data must be {@code a(*),b(*),a(*),b(*),...}. |
|
103 |
* <li><a id="sdnsfi"></a>{@link #SINGLE_DOCUMENT_NEW_SHEET |
|
104 |
* <b>SINGLE_DOCUMENT_NEW_SHEET</b>}. Same as SINGLE_DOCUMENT, except that the |
|
105 |
* printer must ensure that the first impression of each document instance in |
|
106 |
* the job is placed on a new media sheet. This value allows multiple |
|
107 |
* documents to be stapled together with a single staple where each document |
|
108 |
* starts on a new sheet. |
|
109 |
* </ul> |
|
110 |
* <p> |
|
111 |
* {@code SINGLE_DOCUMENT} is the same as |
|
112 |
* {@code SEPARATE_DOCUMENTS_COLLATED_COPIES} with respect to ordering of |
|
113 |
* print-stream pages, but not media sheet generation, since |
|
114 |
* {@code SINGLE_DOCUMENT} will put the first page of the next document on the |
|
115 |
* back side of a sheet if an odd number of pages have been produced so far for |
|
116 |
* the job, while {@code SEPARATE_DOCUMENTS_COLLATED_COPIES} always forces the |
|
2 | 117 |
* next document or document copy on to a new sheet. |
47196 | 118 |
* <p> |
2 | 119 |
* In addition, if a {@link Finishings Finishings} attribute of |
20451
4cedf4e1560a
8025409: Fix javadoc comments errors and warning reported by doclint report
cl
parents:
5506
diff
changeset
|
120 |
* {@link Finishings#STAPLE STAPLE} is specified, then: |
47196 | 121 |
* <ul> |
122 |
* <li>With {@code SINGLE_DOCUMENT}, documents {@code a} and {@code b} are |
|
123 |
* stapled together as a single document with no regard to new sheets. |
|
124 |
* <li>With {@code SINGLE_DOCUMENT_NEW_SHEET}, documents {@code a} and |
|
125 |
* {@code b} are stapled together as a single document, but document {@code b} |
|
126 |
* starts on a new sheet. |
|
127 |
* <li>With {@code SEPARATE_DOCUMENTS_UNCOLLATED_COPIES} and |
|
128 |
* {@code SEPARATE_DOCUMENTS_COLLATED_COPIES}, documents {@code a} and |
|
129 |
* {@code b} are stapled separately. |
|
130 |
* </ul> |
|
131 |
* <i>Note:</i> None of these values provide means to produce uncollated sheets |
|
132 |
* within a document, i.e., where multiple copies of sheet <i>n</i> are produced |
|
133 |
* before sheet <i>n</i>+1 of the same document. To specify that, see the |
|
134 |
* {@link SheetCollate SheetCollate} attribute. |
|
135 |
* <p> |
|
136 |
* <b>IPP Compatibility:</b> The category name returned by {@code getName()} is |
|
137 |
* the IPP attribute name. The enumeration's integer value is the IPP enum |
|
138 |
* value. The {@code toString()} method returns the IPP string representation of |
|
139 |
* the attribute value. |
|
22260
c9185e010e03
8031082: Fix non-missing doclint problems in client libraries
darcy
parents:
20451
diff
changeset
|
140 |
* |
47196 | 141 |
* @author David Mendenhall |
142 |
* @author Alan Kaminsky |
|
143 |
* @see Copies |
|
144 |
* @see Finishings |
|
145 |
* @see NumberUp |
|
146 |
* @see PageRanges |
|
147 |
* @see SheetCollate |
|
148 |
* @see Sides |
|
2 | 149 |
*/ |
150 |
public class MultipleDocumentHandling extends EnumSyntax |
|
151 |
implements PrintRequestAttribute, PrintJobAttribute { |
|
152 |
||
47196 | 153 |
/** |
154 |
* Use serialVersionUID from JDK 1.4 for interoperability. |
|
155 |
*/ |
|
2 | 156 |
private static final long serialVersionUID = 8098326460746413466L; |
157 |
||
158 |
/** |
|
47196 | 159 |
* Single document -- see above for <a href="#sdfi">further information</a>. |
2 | 160 |
*/ |
161 |
public static final MultipleDocumentHandling |
|
162 |
SINGLE_DOCUMENT = new MultipleDocumentHandling (0); |
|
163 |
||
164 |
/** |
|
165 |
* Separate documents uncollated copies -- see above for |
|
47196 | 166 |
* <a href="#sducfi">further information</a>. |
2 | 167 |
*/ |
168 |
public static final MultipleDocumentHandling |
|
169 |
SEPARATE_DOCUMENTS_UNCOLLATED_COPIES = new MultipleDocumentHandling (1); |
|
170 |
||
171 |
/** |
|
172 |
* Separate documents collated copies -- see above for |
|
47196 | 173 |
* <a href="#sdccfi">further information</a>. |
2 | 174 |
*/ |
175 |
public static final MultipleDocumentHandling |
|
176 |
SEPARATE_DOCUMENTS_COLLATED_COPIES = new MultipleDocumentHandling (2); |
|
177 |
||
178 |
/** |
|
47196 | 179 |
* Single document new sheet -- see above for <a href="#sdnsfi">further |
180 |
* information</a>. |
|
2 | 181 |
*/ |
182 |
public static final MultipleDocumentHandling |
|
183 |
SINGLE_DOCUMENT_NEW_SHEET = new MultipleDocumentHandling (3); |
|
184 |
||
185 |
||
186 |
/** |
|
187 |
* Construct a new multiple document handling enumeration value with the |
|
188 |
* given integer value. |
|
189 |
* |
|
47196 | 190 |
* @param value Integer value |
2 | 191 |
*/ |
192 |
protected MultipleDocumentHandling(int value) { |
|
193 |
super (value); |
|
194 |
} |
|
195 |
||
47196 | 196 |
/** |
197 |
* The string table for class {@code MultipleDocumentHandling}. |
|
198 |
*/ |
|
2 | 199 |
private static final String[] myStringTable = { |
200 |
"single-document", |
|
201 |
"separate-documents-uncollated-copies", |
|
202 |
"separate-documents-collated-copies", |
|
203 |
"single-document-new-sheet" |
|
204 |
}; |
|
205 |
||
47196 | 206 |
/** |
207 |
* The enumeration value table for class {@code MultipleDocumentHandling}. |
|
208 |
*/ |
|
2 | 209 |
private static final MultipleDocumentHandling[] myEnumValueTable = { |
210 |
SINGLE_DOCUMENT, |
|
211 |
SEPARATE_DOCUMENTS_UNCOLLATED_COPIES, |
|
212 |
SEPARATE_DOCUMENTS_COLLATED_COPIES, |
|
213 |
SINGLE_DOCUMENT_NEW_SHEET |
|
214 |
}; |
|
215 |
||
216 |
/** |
|
47196 | 217 |
* Returns the string table for class {@code MultipleDocumentHandling}. |
2 | 218 |
*/ |
219 |
protected String[] getStringTable() { |
|
22584
eed64ee05369
8032733: Fix cast lint warnings in client libraries
darcy
parents:
22260
diff
changeset
|
220 |
return myStringTable.clone(); |
2 | 221 |
} |
222 |
||
223 |
/** |
|
47196 | 224 |
* Returns the enumeration value table for class |
225 |
* {@code MultipleDocumentHandling}. |
|
2 | 226 |
*/ |
227 |
protected EnumSyntax[] getEnumValueTable() { |
|
228 |
return (EnumSyntax[])myEnumValueTable.clone(); |
|
229 |
} |
|
230 |
||
231 |
/** |
|
232 |
* Get the printing attribute class which is to be used as the "category" |
|
233 |
* for this printing attribute value. |
|
47196 | 234 |
* <p> |
235 |
* For class {@code MultipleDocumentHandling} and any vendor-defined |
|
236 |
* subclasses, the category is class {@code MultipleDocumentHandling} |
|
237 |
* itself. |
|
2 | 238 |
* |
47196 | 239 |
* @return printing attribute class (category), an instance of class |
240 |
* {@link Class java.lang.Class} |
|
2 | 241 |
*/ |
242 |
public final Class<? extends Attribute> getCategory() { |
|
243 |
return MultipleDocumentHandling.class; |
|
244 |
} |
|
245 |
||
246 |
/** |
|
247 |
* Get the name of the category of which this attribute value is an |
|
248 |
* instance. |
|
47196 | 249 |
* <p> |
250 |
* For class {@code MultipleDocumentHandling} and any vendor-defined |
|
251 |
* subclasses, the category name is {@code "multiple-document-handling"}. |
|
2 | 252 |
* |
47196 | 253 |
* @return attribute category name |
2 | 254 |
*/ |
255 |
public final String getName() { |
|
256 |
return "multiple-document-handling"; |
|
257 |
} |
|
258 |
} |