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

public final Class NumberOfDocuments

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 NumberOfDocuments is an integer valued printing attribute that indicates the number of individual docs the printer has accepted for this job, regardless of whether the docs' print data has reached the printer or not.

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

Author
Alan Kaminsky

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

Construct a new number of documents attribute with the given integer value.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this number of documents attribute, false otherwise
equals(Object
Object to compare to
object)

Overrides javax.print.attribute.IntegerSyntax.equals.

Returns whether this number of documents 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

NumberOfDocumentsback to summary
public NumberOfDocuments(int value)

Construct a new number of documents 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 number of documents 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 NumberOfDocuments.
  3. This number of documents 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 number of documents 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 NumberOfDocuments, the category is class NumberOfDocuments 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 NumberOfDocuments, the category name is "number-of-documents".

Returns:String

attribute category name

Annotations
@Override