- /*
- * @(#)JobPriority.java 1.4 03/01/23
- *
- * Copyright 2003 Sun Microsystems, Inc. All rights reserved.
- * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- */
- package javax.print.attribute.standard;
-
- import javax.print.attribute.IntegerSyntax;
- import javax.print.attribute.PrintRequestAttribute;
- import javax.print.attribute.PrintJobAttribute;
-
- /**
- * Class JobPriority is an integer valued printing attribute class that
- * specifies a print job's priority.
- * <P>
- * If a JobPriority attribute is specified for a Print Job, it specifies a
- * priority for scheduling the job. A higher value specifies a higher priority.
- * The value 1 indicates the lowest possible priority. The value 100 indicates
- * the highest possible priority. Among those jobs that are ready to print, a
- * printer must print all jobs with a priority value of <I>n</I> before printing
- * those with a priority value of <I>n</I>-1 for all <I>n.</I>
- * <P>
- * If the client does not specify a JobPriority attribute for a Print Job and
- * the printer does support the JobPriority attribute, the printer must use an
- * implementation-defined default JobPriority value.
- * <P>
- * The client can always specify any job priority value from 1 to 100 for a job.
- * However, a Print Service instance may support fewer than 100 different
- * job priority levels. If this is the case, the Print Service instance
- * automatically maps the client-specified job priority value to one of the
- * supported job priority levels, dividing the 100 job priority values equally
- * among the available job priority levels.
- * <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 JobPriority extends IntegerSyntax
- implements PrintRequestAttribute, PrintJobAttribute {
-
- /**
- * Construct a new job priority attribute with the given integer value.
- *
- * @param value Integer value.
- *
- * @exception IllegalArgumentException
- * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 1
- * or greater than 100.
- */
- public JobPriority(int value) {
- super (value, 1, 100);
- }
-
- /**
- * Returns whether this job priority 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 JobPriority.
- * <LI>
- * This job priority 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 job
- * priority attribute, false otherwise.
- */
- public boolean equals(Object object) {
- return (super.equals (object) && object instanceof JobPriority);
- }
-
- /**
- * Get the printing attribute class which is to be used as the "category"
- * for this printing attribute value.
- * <P>
- * For class JobPriority, the category is class JobPriority itself.
- *
- * @return Printing attribute class (category), an instance of class
- * {@link java.lang.Class java.lang.Class}.
- */
- public final Class getCategory() {
- return JobPriority.class;
- }
-
- /**
- * Get the name of the category of which this attribute value is an
- * instance.
- * <P>
- * For class JobPriority, the category name is <CODE>"job-priority"</CODE>.
- *
- * @return Attribute category name.
- */
- public final String getName() {
- return "job-priority";
- }
-
- }