APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class JobMediaSheetsCompleted

extends IntegerSyntax
implements PrintJobAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintJobAttribute, javax.print.attribute.Attribute, java.io.Serializable
Imports
java.io.Serial, javax.print.attribute.Attribute, .IntegerSyntax, .PrintJobAttribute
Class JobMediaSheetsCompleted is 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 JobMediaSheetsCompleted attribute describes the progress of the job. This attribute is intended to be a counter. That is, the JobMediaSheetsCompleted value for a job that has not started processing must be 0. When the job's JobState is PROCESSING or PROCESSING_STOPPED, the JobMediaSheetsCompleted value 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 the COMPLETED, CANCELED, or ABORTED states, the JobMediaSheetsCompleted value 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.

Author
Alan Kaminsky
See Also
JobMediaSheets, JobMediaSheetsSupported, JobKOctetsProcessed, JobImpressionsCompleted

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.print.attribute.IntegerSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
JobMediaSheetsCompleted(int
Integer value
value)

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

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this job media sheets completed attribute, false otherwise
equals(Object
Object to compare to
object)

Overrides javax.print.attribute.IntegerSyntax.equals.

Returns whether this job media sheets completed attribute is equivalent to the passed in object.

public final Class<? extends Attribute>

Returns:

printing attribute class (category), an instance of class java.lang.Class
getCategory()

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

public final String

Returns:

attribute category name
getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.IntegerSyntax:
getValuehashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.IntegerSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

JobMediaSheetsCompletedback to summary
public JobMediaSheetsCompleted(int value)

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

Parameters
value:int

Integer value

Exceptions
IllegalArgumentException:
if value is negative

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.IntegerSyntax.equals.

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:

  1. object is not null.
  2. object is an instance of class JobMediaSheetsCompleted.
  3. This job media sheets completed attribute's value and object's value are equal.
Parameters
object:Object

Object to compare to

Returns:boolean

true if object is equivalent to this job media sheets completed attribute, false otherwise

Annotations
@Override
getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements javax.print.attribute.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 class JobMediaSheetsCompleted itself.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations
@Override
getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

For class JobMediaSheetsCompleted, the category name is "job-media-sheets-completed".

Returns:String

attribute category name

Annotations
@Override