001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import javax.print.attribute.Attribute;
028 import javax.print.attribute.IntegerSyntax;
029 import javax.print.attribute.PrintJobAttribute;
030
031 /**
032 * Class JobImpressionsCompleted is an integer valued printing attribute class
033 * that specifies the number of impressions completed for the job so far. For
034 * printing devices, the impressions completed includes interpreting, marking,
035 * and stacking the output.
036 * <P>
037 * The JobImpressionsCompleted attribute describes the progress of the job. This
038 * attribute is intended to be a counter. That is, the JobImpressionsCompleted
039 * value for a job that has not started processing must be 0. When the job's
040 * {@link JobState JobState} is PROCESSING or PROCESSING_STOPPED, the
041 * JobImpressionsCompleted value is intended to increase as the job is
042 * processed; it indicates the amount of the job that has been processed at the
043 * time the Print Job's attribute set is queried or at the time a print job
044 * event is reported. When the job enters the COMPLETED, CANCELED, or ABORTED
045 * states, the JobImpressionsCompleted value is the final value for the job.
046 * <P>
047 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The
048 * category name returned by <CODE>getName()</CODE> gives the IPP attribute
049 * name.
050 * <P>
051 *
052 * @see JobImpressions
053 * @see JobImpressionsSupported
054 * @see JobKOctetsProcessed
055 * @see JobMediaSheetsCompleted
056 *
057 * @author Alan Kaminsky
058 */
059 public final class JobImpressionsCompleted extends IntegerSyntax
060 implements PrintJobAttribute {
061
062 private static final long serialVersionUID = 6722648442432393294L;
063
064 /**
065 * Construct a new job impressions completed attribute with the given
066 * integer value.
067 *
068 * @param value Integer value.
069 *
070 * @exception IllegalArgumentException
071 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
072 */
073 public JobImpressionsCompleted(int value) {
074 super (value, 0, Integer.MAX_VALUE);
075 }
076
077 /**
078 * Returns whether this job impressions completed attribute is equivalent
079 * tp the passed in object. To be equivalent, all of the following
080 * conditions must be true:
081 * <OL TYPE=1>
082 * <LI>
083 * <CODE>object</CODE> is not null.
084 * <LI>
085 * <CODE>object</CODE> is an instance of class JobImpressionsCompleted.
086 * <LI>
087 * This job impressions completed attribute's value and
088 * <CODE>object</CODE>'s value are equal.
089 * </OL>
090 *
091 * @param object Object to compare to.
092 *
093 * @return True if <CODE>object</CODE> is equivalent to this job
094 * impressions completed attribute, false otherwise.
095 */
096 public boolean equals(Object object) {
097 return (super .equals(object) && object instanceof JobImpressionsCompleted);
098 }
099
100 /**
101 * Get the printing attribute class which is to be used as the "category"
102 * for this printing attribute value.
103 * <P>
104 * For class JobImpressionsCompleted, the category is class
105 * JobImpressionsCompleted itself.
106 *
107 * @return Printing attribute class (category), an instance of class
108 * {@link java.lang.Class java.lang.Class}.
109 */
110 public final Class<? extends Attribute> getCategory() {
111 return JobImpressionsCompleted.class;
112 }
113
114 /**
115 * Get the name of the category of which this attribute value is an
116 * instance.
117 * <P>
118 * For class JobImpressionsCompleted, the category name is
119 * <CODE>"job-impressions-completed"</CODE>.
120 *
121 * @return Attribute category name.
122 */
123 public final String getName() {
124 return "job-impressions-completed";
125 }
126
127 }
|