1 /*
2 * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
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
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
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 *
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.
24 */
25 package javax.print.attribute.standard;
26
27 import javax.print.attribute.Attribute;
28 import javax.print.attribute.IntegerSyntax;
29 import javax.print.attribute.PrintRequestAttribute;
30 import javax.print.attribute.PrintJobAttribute;
31
32 /**
33 * Class JobImpressions is an integer valued printing attribute class that
34 * specifies the total size in number of impressions of the document(s) being
35 * submitted. An "impression" is the image (possibly many print-stream pages in
36 * different configurations) imposed onto a single media page.
37 * <P>
38 * The JobImpressions attribute describes the size of the job. This attribute is
39 * not intended to be a counter; it is intended to be useful routing and
40 * scheduling information if known. The printer may try to compute the
41 * JobImpressions attribute's value if it is not supplied in the Print Request.
42 * Even if the client does supply a value for the JobImpressions attribute in
43 * the Print Request, the printer may choose to change the value if the printer
44 * is able to compute a value which is more accurate than the client supplied
45 * value. The printer may be able to determine the correct value for the
46 * JobImpressions attribute either right at job submission time or at any later
47 * point in time.
48 * <P>
49 * As with {@link JobKOctets JobKOctets}, the JobImpressions value must not
50 * include the multiplicative factors contributed by the number of copies
51 * specified by the {@link Copies Copies} attribute, independent of whether the
52 * device can process multiple copies without making multiple passes over the
53 * job or document data and independent of whether the output is collated or
54 * not. Thus the value is independent of the implementation and reflects the
55 * size of the document(s) measured in impressions independent of the number of
56 * copies.
57 * <P>
58 * As with {@link JobKOctets JobKOctets}, the JobImpressions value must also not
59 * include the multiplicative factor due to a copies instruction embedded in the
60 * document data. If the document data actually includes replications of the
61 * document data, this value will include such replication. In other words, this
62 * value is always the number of impressions in the source document data, rather
63 * than a measure of the number of impressions to be produced by the job.
64 * <P>
65 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The
66 * category name returned by <CODE>getName()</CODE> gives the IPP attribute
67 * name.
68 * <P>
69 *
70 * @see JobImpressionsSupported
71 * @see JobImpressionsCompleted
72 * @see JobKOctets
73 * @see JobMediaSheets
74 *
75 * @author Alan Kaminsky
76 */
77 public final class JobImpressions extends IntegerSyntax
78 implements PrintRequestAttribute, PrintJobAttribute {
79
80 private static final long serialVersionUID = 8225537206784322464L;
81
82
83 /**
84 * Construct a new job impressions attribute with the given integer value.
85 *
86 * @param value Integer value.
87 *
88 * @exception IllegalArgumentException
89 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
90 */
91 public JobImpressions(int value) {
92 super(value, 0, Integer.MAX_VALUE);
93 }
94
95 /**
96 * Returns whether this job impressions attribute is equivalent to the
97 * passed in object. To be equivalent, all of the following conditions must
98 * be true:
99 * <OL TYPE=1>
100 * <LI>
101 * <CODE>object</CODE> is not null.
102 * <LI>
103 * <CODE>object</CODE> is an instance of class JobImpressions.
104 * <LI>
105 * This job impressions attribute's value and <CODE>object</CODE>'s value
106 * are equal.
107 * </OL>
108 *
109 * @param object Object to compare to.
110 *
111 * @return True if <CODE>object</CODE> is equivalent to this job
112 * impressions attribute, false otherwise.
113 */
114 public boolean equals(Object object) {
115 return super.equals (object) && object instanceof JobImpressions;
116 }
117
118 /**
119 * Get the printing attribute class which is to be used as the "category"
120 * for this printing attribute value.
121 * <P>
122 * For class JobImpressions, the category is class JobImpressions itself.
123 *
124 * @return Printing attribute class (category), an instance of class
125 * {@link java.lang.Class java.lang.Class}.
126 */
127 public final Class<? extends Attribute> getCategory() {
128 return JobImpressions.class;
129 }
130
131 /**
132 * Get the name of the category of which this attribute value is an
133 * instance.
134 * <P>
135 * For class JobImpressions, the category name is
136 * <CODE>"job-impressions"</CODE>.
137 *
138 * @return Attribute category name.
139 */
140 public final String getName() {
141 return "job-impressions";
142 }
143
144 }