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.PrintRequestAttribute;
030 import javax.print.attribute.PrintJobAttribute;
031
032 /**
033 * Class JobMediaSheets is an integer valued printing attribute class that
034 * specifies the total number of media sheets to be produced for this job.
035 * <P>
036 * The JobMediaSheets attribute describes the size of the job. This attribute is
037 * not intended to be a counter; it is intended to be useful routing and
038 * scheduling information if known. The printer may try to compute the
039 * JobMediaSheets attribute's value if it is not supplied in the Print Request.
040 * Even if the client does supply a value for the JobMediaSheets attribute in
041 * the Print Request, the printer may choose to change the value if the printer
042 * is able to compute a value which is more accurate than the client supplied
043 * value. The printer may be able to determine the correct value for the
044 * JobMediaSheets attribute either right at job submission time or at any later
045 * point in time.
046 * <P>
047 * Unlike the {@link JobKOctets JobKOctets} and {@link JobImpressions
048 * JobImpressions} attributes, the JobMediaSheets value must include the
049 * multiplicative factors contributed by the number of copies specified by the
050 * {@link Copies Copies} attribute and a "number of copies" instruction embedded
051 * in the document data, if any. This difference allows the system administrator
052 * to control the lower and upper bounds of both (1) the size of the document(s)
053 * with {@link JobKOctetsSupported JobKOctetsSupported} and {@link
054 * JobImpressionsSupported JobImpressionsSupported} and (2) the size of the job
055 * with {@link JobMediaSheetsSupported JobMediaSheetsSupported}.
056 * <P>
057 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The
058 * category name returned by <CODE>getName()</CODE> gives the IPP attribute
059 * name.
060 * <P>
061 *
062 * @see JobMediaSheetsSupported
063 * @see JobMediaSheetsCompleted
064 * @see JobKOctets
065 * @see JobImpressions
066 *
067 * @author Alan Kaminsky
068 */
069 public class JobMediaSheets extends IntegerSyntax implements
070 PrintRequestAttribute, PrintJobAttribute {
071
072 private static final long serialVersionUID = 408871131531979741L;
073
074 /**
075 * Construct a new job media sheets attribute with the given integer
076 * value.
077 *
078 * @param value Integer value.
079 *
080 * @exception IllegalArgumentException
081 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
082 */
083 public JobMediaSheets(int value) {
084 super (value, 0, Integer.MAX_VALUE);
085 }
086
087 /**
088 * Returns whether this job media sheets attribute is equivalent to the
089 * passed in object. To be equivalent, all of the following conditions must
090 * be true:
091 * <OL TYPE=1>
092 * <LI>
093 * <CODE>object</CODE> is not null.
094 * <LI>
095 * <CODE>object</CODE> is an instance of class JobMediaSheets.
096 * <LI>
097 * This job media sheets attribute's value and <CODE>object</CODE>'s
098 * value are equal.
099 * </OL>
100 *
101 * @param object Object to compare to.
102 *
103 * @return True if <CODE>object</CODE> is equivalent to this job media
104 * sheets attribute, false otherwise.
105 */
106 public boolean equals(Object object) {
107 return super .equals(object) && object instanceof JobMediaSheets;
108 }
109
110 /**
111 * Get the printing attribute class which is to be used as the "category"
112 * for this printing attribute value.
113 * <P>
114 * For class JobMediaSheets and any vendor-defined subclasses, the category
115 * is class JobMediaSheets itself.
116 *
117 * @return Printing attribute class (category), an instance of class
118 * {@link java.lang.Class java.lang.Class}.
119 */
120 public final Class<? extends Attribute> getCategory() {
121 return JobMediaSheets.class;
122 }
123
124 /**
125 * Get the name of the category of which this attribute value is an
126 * instance.
127 * <P>
128 * For class JobMediaSheets and any vendor-defined subclasses, the
129 * category name is <CODE>"job-media-sheets"</CODE>.
130 *
131 * @return Attribute category name.
132 */
133 public final String getName() {
134 return "job-media-sheets";
135 }
136
137 }
|