javax.print.attribute.standard
Class NumberOfDocuments

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.print.attribute.IntegerSyntax sample code for javax.print.attribute.IntegerSyntax definition code for javax.print.attribute.IntegerSyntax 
      extended by javax.print.attribute.standard.NumberOfDocuments
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable , Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute , PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.PrintJobAttribute

public final class NumberOfDocuments
extends IntegerSyntax sample code for javax.print.attribute.IntegerSyntax definition code for javax.print.attribute.IntegerSyntax
implements PrintJobAttribute sample code for javax.print.attribute.PrintJobAttribute definition code for javax.print.attribute.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.

See Also:
Serialized Form

Constructor Summary
NumberOfDocuments sample code for javax.print.attribute.standard.NumberOfDocuments.NumberOfDocuments(int) definition code for javax.print.attribute.standard.NumberOfDocuments.NumberOfDocuments(int) (int value)
          Construct a new number of documents attribute with the given integer value.
 
Method Summary
 boolean equals sample code for javax.print.attribute.standard.NumberOfDocuments.equals(java.lang.Object) definition code for javax.print.attribute.standard.NumberOfDocuments.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  object)
          Returns whether this number of documents attribute is equivalent to the passed in object.
 Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute > getCategory sample code for javax.print.attribute.standard.NumberOfDocuments.getCategory() definition code for javax.print.attribute.standard.NumberOfDocuments.getCategory() ()
          Get the printing attribute class which is to be used as the "category" for this printing attribute value.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for javax.print.attribute.standard.NumberOfDocuments.getName() definition code for javax.print.attribute.standard.NumberOfDocuments.getName() ()
          Get the name of the category of which this attribute value is an instance.
 
Methods inherited from class javax.print.attribute.IntegerSyntax sample code for javax.print.attribute.IntegerSyntax definition code for javax.print.attribute.IntegerSyntax
getValue sample code for javax.print.attribute.IntegerSyntax.getValue() definition code for javax.print.attribute.IntegerSyntax.getValue() , hashCode sample code for javax.print.attribute.IntegerSyntax.hashCode() definition code for javax.print.attribute.IntegerSyntax.hashCode() , toString sample code for javax.print.attribute.IntegerSyntax.toString() definition code for javax.print.attribute.IntegerSyntax.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

NumberOfDocuments sample code for javax.print.attribute.standard.NumberOfDocuments(int) definition code for javax.print.attribute.standard.NumberOfDocuments(int)

public NumberOfDocuments(int value)
Construct a new number of documents attribute with the given integer value.

Parameters:
value - Integer value.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - (Unchecked exception) Thrown if value is less than 0.
Method Detail

equals sample code for javax.print.attribute.standard.NumberOfDocuments.equals(java.lang.Object) definition code for javax.print.attribute.standard.NumberOfDocuments.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for 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.

Overrides:
equals sample code for javax.print.attribute.IntegerSyntax.equals(java.lang.Object) definition code for javax.print.attribute.IntegerSyntax.equals(java.lang.Object) in class IntegerSyntax sample code for javax.print.attribute.IntegerSyntax definition code for javax.print.attribute.IntegerSyntax
Parameters:
object - Object to compare to.
Returns:
True if object is equivalent to this number of documents attribute, false otherwise.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

getCategory sample code for javax.print.attribute.standard.NumberOfDocuments.getCategory() definition code for javax.print.attribute.standard.NumberOfDocuments.getCategory()

public final Class sample code for java.lang.Class definition code for java.lang.Class <? extends Attribute sample code for javax.print.attribute.Attribute definition code for 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.

Specified by:
getCategory sample code for javax.print.attribute.Attribute.getCategory() definition code for javax.print.attribute.Attribute.getCategory() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Printing attribute class (category), an instance of class java.lang.Class sample code for java.lang.Class definition code for java.lang.Class .

getName sample code for javax.print.attribute.standard.NumberOfDocuments.getName() definition code for javax.print.attribute.standard.NumberOfDocuments.getName()

public final String sample code for java.lang.String definition code for java.lang.String  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".

Specified by:
getName sample code for javax.print.attribute.Attribute.getName() definition code for javax.print.attribute.Attribute.getName() in interface Attribute sample code for javax.print.attribute.Attribute definition code for javax.print.attribute.Attribute
Returns:
Attribute category name.