javax.print.attribute.standard
Class JobKOctets

java.lang.Object
  extended by javax.print.attribute.IntegerSyntax
      extended by javax.print.attribute.standard.JobKOctets
All Implemented Interfaces:
Serializable, Cloneable, Attribute, PrintJobAttribute, PrintRequestAttribute

public final class JobKOctets
extends IntegerSyntax
implements PrintJobAttribute, PrintRequestAttribute

The JobKOctets printing attribute specifies the total size of all the documents of a print job in K octets.

The supplied value has to be rounded up, so that a range between 1 and 1024 octects is specified as 1 and a range between 1025 and 2048 octects as 2, etc. This attribute must not include a multiplication factor from the number of copies which maybe specified in a Copies attribute.

This attribute belongs to a group of job size attributes which are describing the size of a job to be printed. The values supplied by these attributes are intended to be used for routing and scheduling of jobs on the print service. A client may specify these attributes. If a clients supplies these attributes a print service may change the values if its be able to compute a more accurate value at the time of the job submission or also later.

IPP Compatibility: JobKOctets is an IPP 1.1 attribute.

See Also:
JobMediaSheets, JobImpressions, Serialized Form

Constructor Summary
JobKOctets(int value)
          Creates a JobKOctets object.
 
Method Summary
 boolean equals(Object obj)
          Tests if the given object is equal to this object.
 Class<? extends Attribute> getCategory()
          Returns category of this class.
 String getName()
          Returns the name of this attribute.
 
Methods inherited from class javax.print.attribute.IntegerSyntax
getValue, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JobKOctets

public JobKOctets(int value)
Creates a JobKOctets object. The value is in units of K (1024) octets rounded up to the next highest K.

Parameters:
value - the number of K octets
Throws:
IllegalArgumentException - if value < 0
Method Detail

equals

public boolean equals(Object obj)
Tests if the given object is equal to this object.

Overrides:
equals in class IntegerSyntax
Parameters:
obj - the object to test
Returns:
true if both objects are equal, false otherwise.
See Also:
Object.hashCode()

getCategory

public Class<? extends Attribute> getCategory()
Returns category of this class.

Specified by:
getCategory in interface Attribute
Returns:
The class JobKOctets itself.

getName

public String getName()
Returns the name of this attribute.

Specified by:
getName in interface Attribute
Returns:
The name "job-k-octets".