- java.lang.Object
-
- javax.print.attribute.IntegerSyntax
-
- javax.print.attribute.standard.JobMediaSheetsCompleted
-
- All Implemented Interfaces:
Serializable,Cloneable,Attribute,PrintJobAttribute
public final class JobMediaSheetsCompleted extends IntegerSyntax implements PrintJobAttribute
ClassJobMediaSheetsCompletedis an integer valued printing attribute class that specifies the number of media sheets which have completed marking and stacking for the entire job so far, whether those sheets have been processed on one side or on both.The
JobMediaSheetsCompletedattribute describes the progress of the job. This attribute is intended to be a counter. That is, theJobMediaSheetsCompletedvalue for a job that has not started processing must be 0. When the job'sJobStateisPROCESSINGorPROCESSING_STOPPED, theJobMediaSheetsCompletedvalue is intended to increase as the job is processed; it indicates the amount of the job that has been processed at the time the Print Job's attribute set is queried or at the time a print job event is reported. When the job enters theCOMPLETED,CANCELED, orABORTEDstates, theJobMediaSheetsCompletedvalue is the final value for the job.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 JobMediaSheetsCompleted(int value)Construct a new job media sheets completed 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 completed 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
-
JobMediaSheetsCompleted
public JobMediaSheetsCompleted(int value)
Construct a new job media sheets completed 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 completed 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 classJobMediaSheetsCompleted.- This job media sheets completed 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 completed 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
JobMediaSheetsCompleted, the category is classJobMediaSheetsCompleteditself.- Specified by:
getCategoryin interfaceAttribute- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
-
-