javax.print.attribute.standard: public final class: JobMediaSheetsCompleted

javax.print.attribute.standard
public final class: JobMediaSheetsCompleted [javadoc | source]

java.lang.Object
   javax.print.attribute.IntegerSyntax
      javax.print.attribute.standard.JobMediaSheetsCompleted

All Implemented Interfaces:
PrintJobAttribute, Cloneable, Serializable

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 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.

Also see:

JobMediaSheets

JobMediaSheetsSupported

JobKOctetsProcessed

JobImpressionsCompleted

author: Alan - Kaminsky

Constructor:

Constructor:
public JobMediaSheetsCompleted(int value) { super (value, 0, Integer.MAX_VALUE); } Construct a new job media sheets completed attribute with the given integer value. Parameters: `value` - Integer value. Throws: `IllegalArgumentException` - (Unchecked exception) Thrown if `value` is less than 0. exception: `IllegalArgumentException` - (Unchecked exception) Thrown if `value` is less than 0.

 public JobMediaSheetsCompleted(int value) {
        super (value, 0, Integer.MAX_VALUE);
}

Construct a new job media sheets completed attribute with the given integer value.

Parameters:

value - Integer value.

Throws:

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

exception: IllegalArgumentException - (Unchecked exception) Thrown if value is less than 0.

Method from javax.print.attribute.standard.JobMediaSheetsCompleted Summary:
equals, getCategory, getName

Methods from javax.print.attribute.IntegerSyntax:
equals, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.standard.JobMediaSheetsCompleted Detail:
public boolean equals(Object object) { return (super.equals (object) && object instanceof JobMediaSheetsCompleted); } 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.
public final Class<Attribute> getCategory() { return JobMediaSheetsCompleted.class; } 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.
public final String getName() { return "job-media-sheets-completed"; } 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"`.

Method from javax.print.attribute.standard.JobMediaSheetsCompleted Detail:

 public boolean equals(Object object) {
        return (super.equals (object) &&
                object instanceof JobMediaSheetsCompleted);
}

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.

 public final Class<Attribute> getCategory() {
        return JobMediaSheetsCompleted.class;
}

For class JobMediaSheetsCompleted, the category is class JobMediaSheetsCompleted itself.

 public final String getName() {
        return "job-media-sheets-completed";
}

For class JobMediaSheetsCompleted, the category name is "job-media-sheets-completed".