FileDocCategorySizeDatePackage
NumberOfDocuments.javaAPI DocJava SE 5 API2963Fri Aug 26 14:57:44 BST 2005javax.print.attribute.standard

NumberOfDocuments

public final class NumberOfDocuments extends IntegerSyntax implements 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

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public NumberOfDocuments(int value)
Construct a new number of documents attribute with the given integer value.

param
value Integer value.
exception
IllegalArgumentException (Unchecked exception) Thrown if value is less than 0.



                                           
       
	super (value, 0, Integer.MAX_VALUE);
    
Methods Summary
public booleanequals(java.lang.Object object)
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.

param
object Object to compare to.
return
True if object is equivalent to this number of documents attribute, false otherwise.

	return (super.equals (object) &&
		object instanceof NumberOfDocuments);
    
public final java.lang.ClassgetCategory()
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.

return
Printing attribute class (category), an instance of class {@link java.lang.Class java.lang.Class}.

	return NumberOfDocuments.class;
    
public final java.lang.StringgetName()
Get the name of the category of which this attribute value is an instance.

For class NumberOfDocuments, the category name is "number-of-documents".

return
Attribute category name.

	return "number-of-documents";