/*
* @(#)NumberOfInterveningJobs.java 1.8 05/11/17
*
* Copyright 2006 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
package javax.print.attribute.standard;
import javax.print.attribute.Attribute;
import javax.print.attribute.IntegerSyntax;
import javax.print.attribute.PrintJobAttribute;
/**
* Class NumberOfInterveningJobs is an integer valued printing attribute that
* indicates the number of jobs that are ahead of this job in the relative
* chronological order of expected time to complete (i.e., the current
* scheduled order).
* <P>
* <B>IPP Compatibility:</B> The integer value gives the IPP integer value.
* The category name returned by <CODE>getName()</CODE> gives the IPP
* attribute name.
* <P>
*
* @author Alan Kaminsky
*/
public final class NumberOfInterveningJobs extends IntegerSyntax
implements PrintJobAttribute {
private static final long serialVersionUID = 2568141124844982746L;
/**
* Construct a new number of intervening jobs attribute with the given
* integer value.
*
* @param value Integer value.
*
* @exception IllegalArgumentException
* (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
*/
public NumberOfInterveningJobs(int value) {
super(value, 0, Integer.MAX_VALUE);
}
/**
* Returns whether this number of intervening jobs attribute is equivalent
* to the passed in object. To be equivalent, all of the following
* conditions must be true:
* <OL TYPE=1>
* <LI>
* <CODE>object</CODE> is not null.
* <LI>
* <CODE>object</CODE> is an instance of class NumberOfInterveningJobs.
* <LI>
* This number of intervening jobs attribute's value and
* <CODE>object</CODE>'s value are equal.
* </OL>
*
* @param object Object to compare to.
*
* @return True if <CODE>object</CODE> is equivalent to this number of
* intervening jobs attribute, false otherwise.
*/
public boolean equals(Object object) {
return (super.equals (object) &&
object instanceof NumberOfInterveningJobs);
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
* <P>
* For class NumberOfInterveningJobs, the
* category is class NumberOfInterveningJobs itself.
*
* @return Printing attribute class (category), an instance of class
* {@link java.lang.Class java.lang.Class}.
*/
public final Class<? extends Attribute> getCategory() {
return NumberOfInterveningJobs.class;
}
/**
* Get the name of the category of which this attribute value is an
* instance.
* <P>
* For class NumberOfInterveningJobs, the
* category name is <CODE>"number-of-intervening-jobs"</CODE>.
*
* @return Attribute category name.
*/
public final String getName() {
return "number-of-intervening-jobs";
}
}