javax.print.attribute.standard: public class: JobMediaSheets

javax.print.attribute.standard
public class: JobMediaSheets [javadoc | source]

java.lang.Object
   javax.print.attribute.IntegerSyntax
      javax.print.attribute.standard.JobMediaSheets

All Implemented Interfaces:
PrintJobAttribute, PrintRequestAttribute, Cloneable, Serializable

Class JobMediaSheets is an integer valued printing attribute class that specifies the total number of media sheets to be produced for this job.

The JobMediaSheets 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 JobMediaSheets attribute's value if it is not supplied in the Print Request. Even if the client does supply a value for the JobMediaSheets 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 JobMediaSheets attribute either right at job submission time or at any later point in time.

Unlike the JobKOctets and JobImpressions attributes, the JobMediaSheets value must include the multiplicative factors contributed by the number of copies specified by the Copies attribute and a "number of copies" instruction embedded in the document data, if any. This difference allows the system administrator to control the lower and upper bounds of both (1) the size of the document(s) with JobKOctetsSupported and JobImpressionsSupported and (2) the size of the job with JobMediaSheetsSupported .

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

Also see:

JobMediaSheetsSupported

JobMediaSheetsCompleted

JobKOctets

JobImpressions

author: Alan - Kaminsky

Constructor:

Constructor:
public JobMediaSheets(int value) { super (value, 0, Integer.MAX_VALUE); } Construct a new job media sheets attribute with the given integer value. Parameters: `value` - Integer value. Throws: `IllegalArgumentException` - (Unchecked exception) Thrown if `value` is less than 0. exception: `IllegalArgumentException` - (Unchecked exception) Thrown if `value` is less than 0.

 public JobMediaSheets(int value) {
        super (value, 0, Integer.MAX_VALUE);
}

Construct a new job media sheets attribute with the given integer value.

Parameters:

value - Integer value.

Throws:

IllegalArgumentException - (Unchecked exception) Thrown if value is less than 0.

exception: IllegalArgumentException - (Unchecked exception) Thrown if value is less than 0.

Method from javax.print.attribute.standard.JobMediaSheets Summary:
equals, getCategory, getName

Methods from javax.print.attribute.IntegerSyntax:
equals, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.standard.JobMediaSheets Detail:
public boolean equals(Object object) { return super.equals(object) && object instanceof JobMediaSheets; } Returns whether this job media sheets 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 JobMediaSheets. This job media sheets attribute's value and `object`'s value are equal.
public final Class<Attribute> getCategory() { return JobMediaSheets.class; } Get the printing attribute class which is to be used as the "category" for this printing attribute value. For class JobMediaSheets and any vendor-defined subclasses, the category is class JobMediaSheets itself.
public final String getName() { return "job-media-sheets"; } Get the name of the category of which this attribute value is an instance. For class JobMediaSheets and any vendor-defined subclasses, the category name is `"job-media-sheets"`.

Method from javax.print.attribute.standard.JobMediaSheets Detail:

 public boolean equals(Object object) {
        return super.equals(object) && object instanceof JobMediaSheets;
}

object is not null.
object is an instance of class JobMediaSheets.
This job media sheets attribute's value and object's value are equal.

 public final Class<Attribute> getCategory() {
        return JobMediaSheets.class;
}

For class JobMediaSheets and any vendor-defined subclasses, the category is class JobMediaSheets itself.

 public final String getName() {
        return "job-media-sheets";
}

For class JobMediaSheets and any vendor-defined subclasses, the category name is "job-media-sheets".