* 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 {@link Copies Copies} attribute, * 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 {@link javax.print.DocFlavor DocFlavor}, as * 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 | *
| java.awt.image.renderable.RenderableImage | *Implementation dependent* | *
| java.awt.print.Printable | *Implementation dependent* | *
| java.awt.print.Pageable | *Implementation dependent* | *
* * 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
* name.
*
*
* @see JobKOctetsSupported
* @see JobKOctetsProcessed
* @see JobImpressions
* @see JobMediaSheets
*
* @author Alan Kaminsky
*/
public final class JobKOctets extends IntegerSyntax
implements PrintRequestAttribute, PrintJobAttribute {
private static final long serialVersionUID = -8959710146498202869L;
/**
* Construct a new job K octets attribute with the given integer value.
*
* @param value Integer value.
*
* @exception IllegalArgumentException
* (Unchecked exception) Thrown if value is less than 0.
*/
public JobKOctets(int value) {
super (value, 0, Integer.MAX_VALUE);
}
/**
* Returns whether this job K octets 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 JobKOctets.
* object's value
* are equal.
* object is equivalent to this job K
* octets attribute, false otherwise.
*/
public boolean equals(Object object) {
return super.equals(object) && object instanceof JobKOctets;
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
* * For class JobKOctets, the category is class JobKOctets itself. * * @return Printing attribute class (category), an instance of class * {@link java.lang.Class java.lang.Class}. */ public final Class getCategory() { return JobKOctets.class; } /** * Get the name of the category of which this attribute value is an * instance. *
* For class JobKOctets, the category name is "job-k-octets".
*
* @return Attribute category name.
*/
public final String getName() {
return "job-k-octets";
}
}