File Doc Category Size Date Package
JobMediaSheetsCompleted.java API Doc Java SE 5 API 3905 Fri Aug 26 14:57:44 BST 2005 javax.print.attribute.standard

JobMediaSheetsCompleted

java.lang.Object
- javax.print.attribute.IntegerSyntax

public final class JobMediaSheetsCompleted extends IntegerSyntax implements PrintJobAttribute

Class JobMediaSheetsCompleted is an integer valued printing attribute class that specifies the number of media sheets which have completed marking and stacking for the entire job so far, whether those sheets have been processed on one side or on both.

The JobMediaSheetsCompleted attribute describes the progress of the job. This attribute is intended to be a counter. That is, the JobMediaSheetsCompleted value for a job that has not started processing must be 0. When the job's {@link JobState JobState} is PROCESSING or PROCESSING_STOPPED, the JobMediaSheetsCompleted value is intended to increase as the job is processed; it indicates the amount of the job that has been processed at the time the Print Job's attribute set is queried or at the time a print job event is reported. When the job enters the COMPLETED, CANCELED, or ABORTED states, the JobMediaSheetsCompleted value is the final value for the job.

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

see: JobMediaSheets
see: JobMediaSheetsSupported
see: JobKOctetsProcessed
see: JobImpressionsCompleted
author: Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public JobMediaSheetsCompleted(int value)
Construct a new job media sheets completed 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 boolean equals(java.lang.Object object)
Returns whether this job media sheets completed 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 JobMediaSheetsCompleted.
This job media sheets completed 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 completed attribute, false otherwise.
return (super.equals (object) && object instanceof JobMediaSheetsCompleted);
public final java.lang.Class getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.
For class JobMediaSheetsCompleted, the category is class JobMediaSheetsCompleted itself.
return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.
return JobMediaSheetsCompleted.class;
public final java.lang.String getName()
Get the name of the category of which this attribute value is an instance.
For class JobMediaSheetsCompleted, the category name is "job-media-sheets-completed".
return
Attribute category name.
return "job-media-sheets-completed";