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.PrintServiceAttribute;
030
031 /**
032 * Class QueuedJobCount is an integer valued printing attribute that indicates
033 * the number of jobs in the printer whose {@link JobState JobState} is either
034 * PENDING, PENDING_HELD, PROCESSING, or PROCESSING_STOPPED.
035 * <P>
036 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value.
037 * The category name returned by <CODE>getName()</CODE> gives the IPP
038 * attribute name.
039 * <P>
040 *
041 * @author Alan Kaminsky
042 */
043 public final class QueuedJobCount extends IntegerSyntax implements
044 PrintServiceAttribute {
045
046 private static final long serialVersionUID = 7499723077864047742L;
047
048 /**
049 * Construct a new queued job count attribute with the given integer
050 * value.
051 *
052 * @param value Integer value.
053 *
054 * @exception IllegalArgumentException
055 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
056 */
057 public QueuedJobCount(int value) {
058 super (value, 0, Integer.MAX_VALUE);
059 }
060
061 /**
062 * Returns whether this queued job count attribute is equivalent to the
063 * passed in object. To be equivalent, all of the following conditions
064 * mus be true:
065 * <OL TYPE=1>
066 * <LI>
067 * <CODE>object</CODE> is not null.
068 * <LI>
069 * <CODE>object</CODE> is an instance of class QueuedJobCount.
070 * <LI>
071 * This queued job count attribute's value and <CODE>object</CODE>'s
072 * value are equal.
073 * </OL>
074 *
075 * @param object Object to compare to.
076 *
077 * @return True if <CODE>object</CODE> is equivalent to this queued job
078 * count attribute, false otherwise.
079 */
080 public boolean equals(Object object) {
081 return (super .equals(object) && object instanceof QueuedJobCount);
082 }
083
084 /**
085 * Get the printing attribute class which is to be used as the "category"
086 * for this printing attribute value.
087 * <P>
088 * For class QueuedJobCount, the category is class QueuedJobCount itself.
089 *
090 * @return Printing attribute class (category), an instance of class
091 * {@link java.lang.Class java.lang.Class}.
092 */
093 public final Class<? extends Attribute> getCategory() {
094 return QueuedJobCount.class;
095 }
096
097 /**
098 * Get the name of the category of which this attribute value is an
099 * instance.
100 * <P>
101 * For class QueuedJobCount, the
102 * category name is <CODE>"queued-job-count"</CODE>.
103 *
104 * @return Attribute category name.
105 */
106 public final String getName() {
107 return "queued-job-count";
108 }
109
110 }
|