- /*
- * @(#)JobImpressions.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 JobImpressions is an integer valued printing attribute class that
- * specifies the total size in number of impressions of the document(s) being
- * submitted. An "impression" is the image (possibly many print-stream pages in
- * different configurations) imposed onto a single media page.
- * <P>
- * The JobImpressions attribute describes the size of the job. This attribute is
- * not intended to be a counter; it is intended to be useful routing and
- * scheduling information if known. The printer may try to compute the
- * JobImpressions attribute's value if it is not supplied in the Print Request.
- * Even if the client does supply a value for the JobImpressions attribute in
- * the Print Request, the printer may choose to change the value if the printer
- * is able to compute a value which is more accurate than the client supplied
- * value. The printer may be able to determine the correct value for the
- * JobImpressions attribute either right at job submission time or at any later
- * point in time.
- * <P>
- * As with {@link JobKOctets JobKOctets}, the JobImpressions value must not
- * include the multiplicative factors contributed by the number of copies
- * specified by the {@link Copies Copies} attribute, independent of whether the
- * device can process multiple copies without making multiple passes over the
- * job or document data and independent of whether the output is collated or
- * not. Thus the value is independent of the implementation and reflects the
- * size of the document(s) measured in impressions independent of the number of
- * copies.
- * <P>
- * As with {@link JobKOctets JobKOctets}, the JobImpressions value must also not
- * include the multiplicative factor due to a copies instruction embedded in the
- * document data. If the document data actually includes replications of the
- * document data, this value will include such replication. In other words, this
- * value is always the number of impressions in the source document data, rather
- * than a measure of the number of impressions to be produced by the job.
- * <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>
- *
- * @see JobImpressionsSupported
- * @see JobImpressionsCompleted
- * @see JobKOctets
- * @see JobMediaSheets
- *
- * @author Alan Kaminsky
- */
- public final class JobImpressions extends IntegerSyntax
- implements PrintRequestAttribute, PrintJobAttribute {
-
- /**
- * Construct a new job impressions attribute with the given integer value.
- *
- * @param value Integer value.
- *
- * @exception IllegalArgumentException
- * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
- */
- public JobImpressions(int value) {
- super(value, 0, Integer.MAX_VALUE);
- }
-
- /**
- * Returns whether this job impressions 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 JobImpressions.
- * <LI>
- * This job impressions 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
- * impressions attribute, false otherwise.
- */
- public boolean equals(Object object) {
- return super.equals (object) && object instanceof JobImpressions;
- }
-
- /**
- * Get the printing attribute class which is to be used as the "category"
- * for this printing attribute value.
- * <P>
- * For class JobImpressions, the category is class JobImpressions itself.
- *
- * @return Printing attribute class (category), an instance of class
- * {@link java.lang.Class java.lang.Class}.
- */
- public final Class getCategory() {
- return JobImpressions.class;
- }
-
- /**
- * Get the name of the category of which this attribute value is an
- * instance.
- * <P>
- * For class JobImpressions, the category name is
- * <CODE>"job-impressions"</CODE>.
- *
- * @return Attribute category name.
- */
- public final String getName() {
- return "job-impressions";
- }
-
- }