public final class JobKOctets extends IntegerSyntax implements PrintRequestAttribute, PrintJobAttribute
The JobKOctets attribute describes the size of the job. This attribute is not intended to be a counter; it is intended to be useful routing and scheduling information if known. The printer may try to compute the JobKOctets attribute's value if it is not supplied in the Print Request. Even if the client does supply a value for the JobKOctets attribute in the Print Request, the printer may choose to change the value if the printer is able to compute a value which is more accurate than the client supplied value. The printer may be able to determine the correct value for the JobKOctets attribute either right at job submission time or at any later point in time.
The JobKOctets value must not include the multiplicative factors contributed
by the number of copies specified by the
independent of whether the device can process multiple copies without making
multiple passes over the job or document data and independent of whether the
output is collated or not. Thus the value is independent of the
implementation and indicates the size of the document(s) measured in K octets
independent of the number of copies.
The JobKOctets value must also not include the multiplicative factor due to a copies instruction embedded in the document data. If the document data actually includes replications of the document data, this value will include such replication. In other words, this value is always the size of the source document data, rather than a measure of the hardcopy output to be produced.
The size of a doc is computed based on the print data representation class as
specified by the doc's
shown in the table below.
|Representation Class||Document Size|
|byte||Length of the byte array|
|java.io.InputStream||Number of bytes read from the stream|
|char||Length of the character array x 2|
|java.lang.String||Length of the string x 2|
|java.io.Reader||Number of characters read from the stream x 2|
|java.net.URL||Number of bytes read from the file at the given URL address|
* In these cases the Print Service itself generates the print data sent to the printer. If the Print Service supports the JobKOctets attribute, for these cases the Print Service itself must calculate the size of the print data, replacing any JobKOctets value the client specified.
IPP Compatibility: The integer value gives the IPP integer value. The
category name returned by
getName() gives the IPP attribute
|Constructor and Description|
Construct a new job K octets attribute with the given integer value.
|Modifier and Type||Method and Description|
Returns whether this job K octets attribute is equivalent to the passed in object.
Get the printing attribute class which is to be used as the "category" for this printing attribute value.
Get the name of the category of which this attribute value is an instance.
public JobKOctets(int value)
value- Integer value.
IllegalArgumentException- (Unchecked exception) Thrown if
valueis less than 0.
public boolean equals(Object object)
objectis not null.
objectis an instance of class JobKOctets.
object's value are equal.
For class JobKOctets, the category is class JobKOctets itself.
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, 2017, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.