Class JobKOctetsProcessed
- java.lang.Object
-
- javax.print.attribute.IntegerSyntax
-
- javax.print.attribute.standard.JobKOctetsProcessed
-
- All Implemented Interfaces:
- Serializable, Cloneable, Attribute, PrintJobAttribute
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
JobStateis 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
JobKOctetsattribute. 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 theJobKOctetsattribute.IPP Compatibility: The integer value gives the IPP integer value. The category name returned by
getName()gives the IPP attribute name.
-
-
Constructor Summary
Constructors Constructor and Description JobKOctetsProcessed(int value)Construct a new job K octets processed attribute with the given integer value.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description booleanequals(Object object)Returns whether this job K octets processed attribute is equivalent to the passed in object.Class<? extends Attribute>getCategory()Get the printing attribute class which is to be used as the "category" for this printing attribute value.StringgetName()Get the name of the category of which this attribute value is an instance.-
Methods inherited from class javax.print.attribute.IntegerSyntax
getValue, hashCode, toString
-
-
-
-
Constructor Detail
JobKOctetsProcessed
public JobKOctetsProcessed(int value)
Construct a new job K octets processed attribute with the given integer value.- Parameters:
-
value- Integer value. - Throws:
-
IllegalArgumentException- (Unchecked exception) Thrown ifvalueis less than 0.
-
Method Detail
equals
public boolean equals(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:objectis not null.objectis an instance of class JobKOctetsProcessed.- This job K octets processed attribute's value and
object's value are equal.
- Overrides:
-
equalsin classIntegerSyntax - Parameters:
-
object- Object to compare to. - Returns:
-
True if
objectis equivalent to this job K octets processed attribute, false otherwise. - See Also:
-
Object.hashCode(),HashMap
getCategory
public final Class<? extends Attribute> getCategory()
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.
- Specified by:
-
getCategoryin interfaceAttribute - Returns:
-
Printing attribute class (category), an instance of class
java.lang.Class.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
