1 /*
   2  * Copyright (c) 2000, 2014, 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.PrintJobAttribute;
  30 
  31 /**
  32  * Class NumberOfInterveningJobs is an integer valued printing attribute that
  33  * indicates the number of jobs that are ahead of this job in the relative
  34  * chronological order of expected time to complete (i.e., the current
  35  * scheduled order).
  36  * <P>
  37  * <B>IPP Compatibility:</B> The integer value gives the IPP integer value.
  38  * The category name returned by {@code getName()} gives the IPP
  39  * attribute name.
  40  *
  41  * @author  Alan Kaminsky
  42  */
  43 public final class NumberOfInterveningJobs extends IntegerSyntax
  44     implements PrintJobAttribute {
  45 
  46     private static final long serialVersionUID = 2568141124844982746L;
  47 
  48     /**
  49      * Construct a new number of intervening jobs attribute with the given
  50      * integer value.
  51      *
  52      * @param  value  Integer value.
  53      *
  54      * @exception  IllegalArgumentException
  55      *   (Unchecked exception) Thrown if {@code value} is less than 0.
  56      */
  57     public NumberOfInterveningJobs(int value) {
  58         super(value, 0, Integer.MAX_VALUE);
  59     }
  60 
  61     /**
  62      * Returns whether this number of intervening jobs attribute is equivalent
  63      * to the passed in object. To be equivalent, all of the following
  64      * conditions must be true:
  65      * <OL TYPE=1>
  66      * <LI>
  67      * {@code object} is not null.
  68      * <LI>
  69      * {@code object} is an instance of class NumberOfInterveningJobs.
  70      * <LI>
  71      * This number of intervening jobs attribute's value and
  72      * {@code object}'s value are equal.
  73      * </OL>
  74      *
  75      * @param  object  Object to compare to.
  76      *
  77      * @return  True if {@code object} is equivalent to this number of
  78      *          intervening jobs attribute, false otherwise.
  79      */
  80     public boolean equals(Object object) {
  81         return (super.equals (object) &&
  82                 object instanceof NumberOfInterveningJobs);
  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 NumberOfInterveningJobs, the
  90      * category is class NumberOfInterveningJobs itself.
  91      *
  92      * @return  Printing attribute class (category), an instance of class
  93      *          {@link java.lang.Class java.lang.Class}.
  94      */
  95     public final Class<? extends Attribute> getCategory() {
  96         return NumberOfInterveningJobs.class;
  97     }
  98 
  99     /**
 100      * Get the name of the category of which this attribute value is an
 101      * instance.
 102      * <P>
 103      * For class NumberOfInterveningJobs, the
 104      * category name is {@code "number-of-intervening-jobs"}.
 105      *
 106      * @return  Attribute category name.
 107      */
 108     public final String getName() {
 109         return "number-of-intervening-jobs";
 110     }
 111 
 112 }