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

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

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

All Implemented Interfaces:
PrintJobAttribute, Cloneable, Serializable

Class JobImpressionsCompleted is an integer valued printing attribute class that specifies the number of impressions completed for the job so far. For printing devices, the impressions completed includes interpreting, marking, and stacking the output.

The JobImpressionsCompleted attribute describes the progress of the job. This attribute is intended to be a counter. That is, the JobImpressionsCompleted value for a job that has not started processing must be 0. When the job's JobState is PROCESSING or PROCESSING_STOPPED, the JobImpressionsCompleted 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 JobImpressionsCompleted 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:

JobImpressions

JobImpressionsSupported

JobKOctetsProcessed

JobMediaSheetsCompleted

author: Alan - Kaminsky

Constructor:

Constructor:
public JobImpressionsCompleted(int value) { super (value, 0, Integer.MAX_VALUE); } Construct a new job impressions 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 JobImpressionsCompleted(int value) {
        super (value, 0, Integer.MAX_VALUE);
}

Construct a new job impressions 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.JobImpressionsCompleted 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.JobImpressionsCompleted Detail:
public boolean equals(Object object) { return(super.equals (object) && object instanceof JobImpressionsCompleted); } Returns whether this job impressions completed attribute is equivalent tp 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 JobImpressionsCompleted. This job impressions completed attribute's value and `object`'s value are equal.
public final Class<Attribute> getCategory() { return JobImpressionsCompleted.class; } Get the printing attribute class which is to be used as the "category" for this printing attribute value. For class JobImpressionsCompleted, the category is class JobImpressionsCompleted itself.
public final String getName() { return "job-impressions-completed"; } Get the name of the category of which this attribute value is an instance. For class JobImpressionsCompleted, the category name is `"job-impressions-completed"`.

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

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

object is not null.
object is an instance of class JobImpressionsCompleted.
This job impressions completed attribute's value and object's value are equal.

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

For class JobImpressionsCompleted, the category is class JobImpressionsCompleted itself.

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

For class JobImpressionsCompleted, the category name is "job-impressions-completed".