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

public Class JobMediaSheets

extends IntegerSyntax
implements PrintRequestAttribute, PrintJobAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintJobAttribute, javax.print.attribute.Attribute, java.io.Serializable, javax.print.attribute.PrintRequestAttribute
Imports
java.io.Serial, javax.print.attribute.Attribute, .IntegerSyntax, .PrintJobAttribute, .PrintRequestAttribute

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.

Author
Alan Kaminsky
See Also
JobMediaSheetsSupported, JobMediaSheetsCompleted, JobKOctets, JobImpressions

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
JobMediaSheets(int
Integer value
value
)

Construct a new job media sheets 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 attribute, false otherwise
equals
(Object
Object to compare to
object
)

Overrides javax.print.attribute.IntegerSyntax.equals.

Returns whether this job media sheets 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

JobMediaSheetsback to summary
public JobMediaSheets(int value)

Construct a new job media sheets 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 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 JobMediaSheets.
  3. This job media sheets 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 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 JobMediaSheets and any vendor-defined subclasses, the category is class JobMediaSheets 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 JobMediaSheets and any vendor-defined subclasses, the category name is "job-media-sheets".

Returns:String

attribute category name

Annotations
@Override