- java.lang.Object
-
- javax.print.attribute.IntegerSyntax
-
- javax.print.attribute.standard.JobMediaSheets
-
- All Implemented Interfaces:
Serializable,Cloneable,Attribute,PrintJobAttribute,PrintRequestAttribute
public class JobMediaSheets extends IntegerSyntax implements PrintRequestAttribute, PrintJobAttribute
ClassJobMediaSheetsis an integer valued printing attribute class that specifies the total number of media sheets to be produced for this job.The
JobMediaSheetsattribute 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 theJobMediaSheetsattribute's value if it is not supplied in the Print Request. Even if the client does supply a value for theJobMediaSheetsattribute 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 theJobMediaSheetsattribute either right at job submission time or at any later point in time.Unlike the
JobKOctetsandJobImpressionsattributes, theJobMediaSheetsvalue must include the multiplicative factors contributed by the number of copies specified by theCopiesattribute 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) withJobKOctetsSupportedandJobImpressionsSupportedand (2) the size of the job withJobMediaSheetsSupported.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 Description JobMediaSheets(int value)Construct a new job media sheets attribute with the given integer value.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object object)Returns whether this job media sheets 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 declared in class javax.print.attribute.IntegerSyntax
getValue, hashCode, toString
-
-
-
-
Constructor Detail
-
JobMediaSheets
public JobMediaSheets(int value)
Construct a new job media sheets attribute with the given integer value.- Parameters:
value- Integer value- Throws:
IllegalArgumentException- ifvalueis negative
-
-
Method Detail
-
equals
public boolean equals(Object object)
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:objectis notnull.objectis an instance of classJobMediaSheets.- This job media sheets attribute's value and
object's value are equal.
- Overrides:
equalsin classIntegerSyntax- Parameters:
object-Objectto compare to- Returns:
trueifobjectis equivalent to this job media sheets attribute,falseotherwise- See Also:
Object.hashCode()
-
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
JobMediaSheetsand any vendor-defined subclasses, the category is classJobMediaSheetsitself.- Specified by:
getCategoryin interfaceAttribute- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
-