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