1 /*
2 * Copyright 2000-2004 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any 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.PrintServiceAttribute;
30
31 /**
32 * Class QueuedJobCount is an integer valued printing attribute that indicates
33 * the number of jobs in the printer whose {@link JobState JobState} is either
34 * PENDING, PENDING_HELD, PROCESSING, or PROCESSING_STOPPED.
35 * <P>
36 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value.
37 * The category name returned by <CODE>getName()</CODE> gives the IPP
38 * attribute name.
39 * <P>
40 *
41 * @author Alan Kaminsky
42 */
43 public final class QueuedJobCount extends IntegerSyntax
44 implements PrintServiceAttribute {
45
46 private static final long serialVersionUID = 7499723077864047742L;
47
48 /**
49 * Construct a new queued job count attribute with the given integer
50 * value.
51 *
52 * @param value Integer value.
53 *
54 * @exception IllegalArgumentException
55 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
56 */
57 public QueuedJobCount(int value) {
58 super (value, 0, Integer.MAX_VALUE);
59 }
60
61 /**
62 * Returns whether this queued job count attribute is equivalent to the
63 * passed in object. To be equivalent, all of the following conditions
64 * mus be true:
65 * <OL TYPE=1>
66 * <LI>
67 * <CODE>object</CODE> is not null.
68 * <LI>
69 * <CODE>object</CODE> is an instance of class QueuedJobCount.
70 * <LI>
71 * This queued job count attribute's value and <CODE>object</CODE>'s
72 * value are equal.
73 * </OL>
74 *
75 * @param object Object to compare to.
76 *
77 * @return True if <CODE>object</CODE> is equivalent to this queued job
78 * count attribute, false otherwise.
79 */
80 public boolean equals(Object object) {
81 return (super.equals (object) &&
82 object instanceof QueuedJobCount);
83 }
84
85 /**
86 * Get the printing attribute class which is to be used as the "category"
87 * for this printing attribute value.
88 * <P>
89 * For class QueuedJobCount, the category is class QueuedJobCount itself.
90 *
91 * @return Printing attribute class (category), an instance of class
92 * {@link java.lang.Class java.lang.Class}.
93 */
94 public final Class<? extends Attribute> getCategory() {
95 return QueuedJobCount.class;
96 }
97
98 /**
99 * Get the name of the category of which this attribute value is an
100 * instance.
101 * <P>
102 * For class QueuedJobCount, the
103 * category name is <CODE>"queued-job-count"</CODE>.
104 *
105 * @return Attribute category name.
106 */
107 public final String getName() {
108 return "queued-job-count";
109 }
110
111 }
Save This Page