1 /*
2  * Copyright (c) 2000, 2017, 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 
26 package javax.print.attribute.standard;
27 
28 import javax.print.attribute.Attribute;
29 import javax.print.attribute.IntegerSyntax;
30 import javax.print.attribute.PrintJobAttribute;
31 
32 /**
33  * Class {@code NumberOfInterveningJobs} is an integer valued printing attribute
34  * that indicates the number of jobs that are ahead of this job in the relative
35  * chronological order of expected time to complete (i.e., the current scheduled
36  * order).
37  * <p>
38  * <b>IPP Compatibility:</b> The integer value gives the IPP integer value. The
39  * category name returned by {@code getName()} gives the IPP attribute name.
40  *
41  * @author Alan Kaminsky
42  */
43 public final class NumberOfInterveningJobs extends IntegerSyntax
44     implements PrintJobAttribute {
45 
46     /**
47      * Use serialVersionUID from JDK 1.4 for interoperability.
48      */
49     private static final long serialVersionUID = 2568141124844982746L;
50 
51     /**
52      * Construct a new number of intervening jobs attribute with the given
53      * integer value.
54      *
55      * @param  value Integer value
56      * @throws IllegalArgumentException if {@code value} is negative
57      */
NumberOfInterveningJobs(int value)58     public NumberOfInterveningJobs(int value) {
59         super(value, 0, Integer.MAX_VALUE);
60     }
61 
62     /**
63      * Returns whether this number of intervening jobs attribute is equivalent
64      * to the passed in object. To be equivalent, all of the following
65      * conditions must be true:
66      * <ol type=1>
67      *   <li>{@code object} is not {@code null}.
68      *   <li>{@code object} is an instance of class
69      *   {@code NumberOfInterveningJobs}.
70      *   <li>This number of intervening jobs attribute's value and
71      *   {@code object}'s value are equal.
72      * </ol>
73      *
74      * @param  object {@code Object} to compare to
75      * @return {@code true} if {@code object} is equivalent to this number of
76      *         intervening jobs attribute, {@code false} otherwise
77      */
equals(Object object)78     public boolean equals(Object object) {
79         return (super.equals (object) &&
80                 object instanceof NumberOfInterveningJobs);
81     }
82 
83     /**
84      * Get the printing attribute class which is to be used as the "category"
85      * for this printing attribute value.
86      * <p>
87      * For class {@code NumberOfInterveningJobs}, the category is class
88      * {@code NumberOfInterveningJobs} itself.
89      *
90      * @return printing attribute class (category), an instance of class
91      *         {@link Class java.lang.Class}
92      */
getCategory()93     public final Class<? extends Attribute> getCategory() {
94         return NumberOfInterveningJobs.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 {@code NumberOfInterveningJobs}, the category name is
102      * {@code "number-of-intervening-jobs"}.
103      *
104      * @return attribute category name
105      */
getName()106     public final String getName() {
107         return "number-of-intervening-jobs";
108     }
109 }
110