JobMediaSheets.java revision 2362
2362N/A * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 2362N/A * published by the Free Software Foundation. Oracle designates this 0N/A * particular file as subject to the "Classpath" exception as provided 2362N/A * by Oracle in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2362N/A * or visit www.oracle.com if you need additional information or have any 0N/A * Class JobMediaSheets is an integer valued printing attribute class that 0N/A * specifies the total number of media sheets to be produced for this job. 0N/A * The JobMediaSheets attribute describes the size of the job. This attribute is 0N/A * not intended to be a counter; it is intended to be useful routing and 0N/A * scheduling information if known. The printer may try to compute the 0N/A * JobMediaSheets attribute's value if it is not supplied in the Print Request. 0N/A * Even if the client does supply a value for the JobMediaSheets attribute in 0N/A * the Print Request, the printer may choose to change the value if the printer 0N/A * is able to compute a value which is more accurate than the client supplied 0N/A * value. The printer may be able to determine the correct value for the 0N/A * JobMediaSheets attribute either right at job submission time or at any later 0N/A * Unlike the {@link JobKOctets JobKOctets} and {@link JobImpressions 0N/A * JobImpressions} attributes, the JobMediaSheets value must include the 0N/A * multiplicative factors contributed by the number of copies specified by the 0N/A * {@link Copies Copies} attribute and a "number of copies" instruction embedded 0N/A * in the document data, if any. This difference allows the system administrator 0N/A * to control the lower and upper bounds of both (1) the size of the document(s) 0N/A * with {@link JobKOctetsSupported JobKOctetsSupported} and {@link 0N/A * JobImpressionsSupported JobImpressionsSupported} and (2) the size of the job 0N/A * with {@link JobMediaSheetsSupported JobMediaSheetsSupported}. 0N/A * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The 0N/A * category name returned by <CODE>getName()</CODE> gives the IPP attribute 0N/A * @see JobMediaSheetsSupported 0N/A * @see JobMediaSheetsCompleted 0N/A * @see JobImpressions 0N/A * @author Alan Kaminsky 0N/A * Construct a new job media sheets attribute with the given integer 0N/A * @param value Integer value. 0N/A * @exception IllegalArgumentException 0N/A * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0. 0N/A * Returns whether this job media sheets attribute is equivalent to the 0N/A * passed in object. To be equivalent, all of the following conditions must 0N/A * <CODE>object</CODE> is not null. 0N/A * <CODE>object</CODE> is an instance of class JobMediaSheets. 0N/A * This job media sheets attribute's value and <CODE>object</CODE>'s 0N/A * @param object Object to compare to. 0N/A * @return True if <CODE>object</CODE> is equivalent to this job media 0N/A * sheets attribute, false otherwise. 0N/A * Get the printing attribute class which is to be used as the "category" 0N/A * for this printing attribute value. 0N/A * For class JobMediaSheets and any vendor-defined subclasses, the category 0N/A * is class JobMediaSheets itself. 0N/A * @return Printing attribute class (category), an instance of class 0N/A * {@link java.lang.Class java.lang.Class}. 0N/A * Get the name of the category of which this attribute value is an 0N/A * For class JobMediaSheets and any vendor-defined subclasses, the 0N/A * category name is <CODE>"job-media-sheets"</CODE>. 0N/A * @return Attribute category name. 0N/A return "job-media-sheets";