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

JobKOctetsProcessed

public final class JobKOctetsProcessed extends IntegerSyntax implements PrintJobAttribute
Class JobKOctetsProcessed is an integer valued printing attribute class that specifies the total number of print data octets processed so far in K octets, i.e., in units of 1024 octets. The value must be rounded up, so that a job between 1 and 1024 octets inclusive must be indicated as being 1K octets, 1025 to 2048 inclusive must be 2K, etc. For a multidoc print job (a job with multiple documents), the JobKOctetsProcessed value is computed by adding up the individual documents' number of octets processed so far, then rounding up to the next K octets value.

The JobKOctetsProcessed attribute describes the progress of the job. This attribute is intended to be a counter. That is, the JobKOctetsProcessed 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 JobKOctetsProcessed 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 JobKOctetsProcessed value is the final value for the job.

For implementations where multiple copies are produced by the interpreter with only a single pass over the data, the final value of the JobKOctetsProcessed attribute must be equal to the value of the {@link JobKOctets JobKOctets} attribute. For implementations where multiple copies are produced by the interpreter by processing the data for each copy, the final value must be a multiple of the value of the {@link JobKOctets JobKOctets} attribute.

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

see
JobKOctets
see
JobKOctetsSupported
see
JobImpressionsCompleted
see
JobMediaSheetsCompleted
author
Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public JobKOctetsProcessed(int value)
Construct a new job K octets processed 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 K octets processed 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 JobKOctetsProcessed.
  3. This job K octets processed attribute's value and object's value are equal.

param
object Object to compare to.
return
True if object is equivalent to this job K octets processed attribute, false otherwise.

	return(super.equals (object) &&
	       object instanceof JobKOctetsProcessed);
    
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 JobKOctetsProcessed, the category is class JobKOctetsProcessed itself.

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

	return JobKOctetsProcessed.class;
    
public final java.lang.StringgetName()
Get the name of the category of which this attribute value is an instance.

For class JobKOctetsProcessed, the category name is "job-k-octets-processed".

return
Attribute category name.

	return "job-k-octets-processed";