FileDocCategorySizeDatePackage
JobMediaSheets.javaAPI DocJava SE 5 API4483Fri Aug 26 14:57:44 BST 2005javax.print.attribute.standard

JobMediaSheets

public class JobMediaSheets extends IntegerSyntax implements PrintJobAttribute, PrintRequestAttribute
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 {@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}.

IPP Compatibility: The integer value gives the IPP integer value. The category name returned by getName() gives the IPP attribute name.

see
JobMediaSheetsSupported
see
JobMediaSheetsCompleted
see
JobKOctets
see
JobImpressions
author
Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public JobMediaSheets(int value)
Construct a new job media sheets attribute with the given integer value.

param
value Integer value.
exception
IllegalArgumentException (Unchecked exception) Thrown if value is less than 0.


                                          
       
	super (value, 0, Integer.MAX_VALUE);
Methods Summary
public booleanequals(java.lang.Object object)
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:
  1. object is not null.
  2. object is an instance of class JobMediaSheets.
  3. This job media sheets attribute's value and object's value are equal.

param
object Object to compare to.
return
True if object is equivalent to this job media sheets attribute, false otherwise.

	return super.equals(object) && object instanceof JobMediaSheets;
public final java.lang.ClassgetCategory()
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.

return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

	return JobMediaSheets.class;
public final java.lang.StringgetName()
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".

return
Attribute category name.

	return "job-media-sheets";