/*
* Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javax.print.attribute.standard;
import javax.print.attribute.Attribute;
import javax.print.attribute.IntegerSyntax;
import javax.print.attribute.PrintRequestAttribute;
import javax.print.attribute.PrintJobAttribute;
Class JobMediaSheets is an integer valued printing attribute class that
specifies the total number of media sheets to be produced for this job.
The JobMediaSheets 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
JobMediaSheets attribute's value if it is not supplied in the Print Request.
Even if the client does supply a value for the JobMediaSheets 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
JobMediaSheets attribute either right at job submission time or at any later
point in time.
Unlike the JobKOctets and
JobImpressions attributes, the JobMediaSheets value must include the multiplicative factors contributed by the number of copies specified by the Copies attribute and a "number of copies" instruction embedded in the document data, if any. This difference allows the system administrator to control the lower and upper bounds of both (1) the size of the document(s) with JobKOctetsSupported and JobImpressionsSupported and (2) the size of the job with JobMediaSheetsSupported.
IPP Compatibility: The integer value gives the IPP integer value. The category name returned by getName() gives the IPP attribute name.
Author: Alan Kaminsky See Also:
/**
* Class JobMediaSheets is an integer valued printing attribute class that
* specifies the total number of media sheets to be produced for this job.
* <P>
* The JobMediaSheets 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
* JobMediaSheets attribute's value if it is not supplied in the Print Request.
* Even if the client does supply a value for the JobMediaSheets 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
* JobMediaSheets attribute either right at job submission time or at any later
* point in time.
* <P>
* Unlike the {@link JobKOctets JobKOctets} and {@link JobImpressions
* JobImpressions} attributes, the JobMediaSheets value must include the
* multiplicative factors contributed by the number of copies specified by the
* {@link Copies Copies} attribute and a "number of copies" instruction embedded
* in the document data, if any. This difference allows the system administrator
* to control the lower and upper bounds of both (1) the size of the document(s)
* with {@link JobKOctetsSupported JobKOctetsSupported} and {@link
* JobImpressionsSupported JobImpressionsSupported} and (2) the size of the job
* with {@link JobMediaSheetsSupported JobMediaSheetsSupported}.
* <P>
* <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The
* category name returned by {@code getName()} gives the IPP attribute
* name.
*
* @see JobMediaSheetsSupported
* @see JobMediaSheetsCompleted
* @see JobKOctets
* @see JobImpressions
*
* @author Alan Kaminsky
*/
public class JobMediaSheets extends IntegerSyntax
implements PrintRequestAttribute, PrintJobAttribute {
private static final long serialVersionUID = 408871131531979741L;
Construct a new job media sheets attribute with the given integer
value.
Params: - value – Integer value.
Throws: - IllegalArgumentException – (Unchecked exception) Thrown if
value is less than 0.
/**
* Construct a new job media sheets attribute with the given integer
* value.
*
* @param value Integer value.
*
* @exception IllegalArgumentException
* (Unchecked exception) Thrown if {@code value} is less than 0.
*/
public JobMediaSheets(int value) {
super (value, 0, Integer.MAX_VALUE);
}
Returns whether this job media sheets attribute is equivalent to the
passed in object. To be equivalent, all of the following conditions must
be true:
-
object is not null. -
object is an instance of class JobMediaSheets. - This job media sheets attribute's value and
object's value are equal.
Params: - object – Object to compare to.
Returns: True if object is equivalent to this job media sheets attribute, false otherwise.
/**
* Returns whether this job media sheets 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} is not null.
* <LI>
* {@code object} is an instance of class JobMediaSheets.
* <LI>
* This job media sheets attribute's value and {@code object}'s
* value are equal.
* </OL>
*
* @param object Object to compare to.
*
* @return True if {@code object} is equivalent to this job media
* sheets attribute, false otherwise.
*/
public boolean equals(Object object) {
return super.equals(object) && object instanceof JobMediaSheets;
}
Get the printing attribute class which is to be used as the "category"
for this printing attribute value.
For class JobMediaSheets and any vendor-defined subclasses, the category
is class JobMediaSheets itself.
Returns: Printing attribute class (category), an instance of class java.lang.Class.
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
* <P>
* For class JobMediaSheets and any vendor-defined subclasses, the category
* is class JobMediaSheets itself.
*
* @return Printing attribute class (category), an instance of class
* {@link java.lang.Class java.lang.Class}.
*/
public final Class<? extends Attribute> getCategory() {
return JobMediaSheets.class;
}
Get the name of the category of which this attribute value is an
instance.
For class JobMediaSheets and any vendor-defined subclasses, the category name is "job-media-sheets".
Returns: Attribute category name.
/**
* Get the name of the category of which this attribute value is an
* instance.
* <P>
* For class JobMediaSheets and any vendor-defined subclasses, the
* category name is {@code "job-media-sheets"}.
*
* @return Attribute category name.
*/
public final String getName() {
return "job-media-sheets";
}
}