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.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  *
  40  * @author  Alan Kaminsky
  41  */
  42 public final class QueuedJobCount extends IntegerSyntax
  43     implements PrintServiceAttribute {
  44 
  45     private static final long serialVersionUID = 7499723077864047742L;
  46 
  47     /**
  48      * Construct a new queued job count attribute with the given integer
  49      * value.
  50      *
  51      * @param  value  Integer value.
  52      *
  53      * @exception  IllegalArgumentException
  54      *   (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
  55      */
  56     public QueuedJobCount(int value) {
  57         super (value, 0, Integer.MAX_VALUE);
  58     }
  59 
  60     /**
  61      * Returns whether this queued job count attribute is equivalent to the
  62      * passed in object. To be equivalent, all of the following conditions
  63      * mus  be true:
  64      * <OL TYPE=1>
  65      * <LI>
  66      * <CODE>object</CODE> is not null.
  67      * <LI>
  68      * <CODE>object</CODE> is an instance of class QueuedJobCount.
  69      * <LI>
  70      * This queued job count attribute's value and <CODE>object</CODE>'s
  71      * value are equal.
  72      * </OL>
  73      *
  74      * @param  object  Object to compare to.
  75      *
  76      * @return  True if <CODE>object</CODE> is equivalent to this queued job
  77      *          count attribute, false otherwise.
  78      */
  79     public boolean equals(Object object) {
  80         return (super.equals (object) &&
  81                object instanceof QueuedJobCount);
  82     }
  83 
  84     /**
  85      * Get the printing attribute class which is to be used as the "category"
  86      * for this printing attribute value.
  87      * <P>
  88      * For class QueuedJobCount, the category is class QueuedJobCount itself.
  89      *
  90      * @return  Printing attribute class (category), an instance of class
  91      *          {@link java.lang.Class java.lang.Class}.
  92      */
  93     public final Class<? extends Attribute> getCategory() {
  94         return QueuedJobCount.class;
  95     }
  96 
  97     /**
  98      * Get the name of the category of which this attribute value is an
  99      * 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 }