001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import javax.print.attribute.Attribute;
028 import javax.print.attribute.IntegerSyntax;
029 import javax.print.attribute.PrintRequestAttribute;
030 import javax.print.attribute.PrintJobAttribute;
031
032 /**
033 * Class Copies is an integer valued printing attribute class that specifies the
034 * number of copies to be printed.
035 * <P>
036 * On many devices the supported number of collated copies will be limited by
037 * the number of physical output bins on the device, and may be different from
038 * the number of uncollated copies which can be supported.
039 * <P>
040 * The effect of a Copies attribute with a value of <I>n</I> on a multidoc print
041 * job (a job with multiple documents) depends on the (perhaps defaulted) value
042 * of the {@link MultipleDocumentHandling MultipleDocumentHandling} attribute:
043 * <UL>
044 * <LI>
045 * SINGLE_DOCUMENT -- The result will be <I>n</I> copies of a single output
046 * document comprising all the input docs.
047 * <P>
048 * <LI>
049 * SINGLE_DOCUMENT_NEW_SHEET -- The result will be <I>n</I> copies of a single
050 * output document comprising all the input docs, and the first impression of
051 * each input doc will always start on a new media sheet.
052 * <P>
053 * <LI>
054 * SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- The result will be <I>n</I> copies of
055 * the first input document, followed by <I>n</I> copies of the second input
056 * document, . . . followed by <I>n</I> copies of the last input document.
057 * <P>
058 * <LI>
059 * SEPARATE_DOCUMENTS_COLLATED_COPIES -- The result will be the first input
060 * document, the second input document, . . . the last input document, the group
061 * of documents being repeated <I>n</I> times.
062 * </UL>
063 * <P>
064 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The
065 * category name returned by <CODE>getName()</CODE> gives the IPP attribute
066 * name.
067 * <P>
068 *
069 * @author David Mendenhall
070 * @author Alan Kamihensky
071 */
072 public final class Copies extends IntegerSyntax implements
073 PrintRequestAttribute, PrintJobAttribute {
074
075 private static final long serialVersionUID = -6426631521680023833L;
076
077 /**
078 * Construct a new copies attribute with the given integer value.
079 *
080 * @param value Integer value.
081 *
082 * @exception IllegalArgumentException
083 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 1.
084 */
085 public Copies(int value) {
086 super (value, 1, Integer.MAX_VALUE);
087 }
088
089 /**
090 * Returns whether this copies attribute is equivalent to the passed in
091 * object. To be equivalent, all of the following conditions must be true:
092 * <OL TYPE=1>
093 * <LI>
094 * <CODE>object</CODE> is not null.
095 * <LI>
096 * <CODE>object</CODE> is an instance of class Copies.
097 * <LI>
098 * This copies attribute's value and <CODE>object</CODE>'s value are
099 * equal.
100 * </OL>
101 *
102 * @param object Object to compare to.
103 *
104 * @return True if <CODE>object</CODE> is equivalent to this copies
105 * attribute, false otherwise.
106 */
107 public boolean equals(Object object) {
108 return super .equals(object) && object instanceof Copies;
109 }
110
111 /**
112 * Get the printing attribute class which is to be used as the "category"
113 * for this printing attribute value.
114 * <P>
115 * For class Copies, the category is class Copies itself.
116 *
117 * @return Printing attribute class (category), an instance of class
118 * {@link java.lang.Class java.lang.Class}.
119 */
120 public final Class<? extends Attribute> getCategory() {
121 return Copies.class;
122 }
123
124 /**
125 * Get the name of the category of which this attribute value is an
126 * instance.
127 * <P>
128 * For class Copies, the category name is <CODE>"copies"</CODE>.
129 *
130 * @return Attribute category name.
131 */
132 public final String getName() {
133 return "copies";
134 }
135
136 }
|