javax.print.attribute.standard: public final class: NumberOfDocuments

javax.print.attribute.standard
public final class: NumberOfDocuments [javadoc | source]

java.lang.Object
   javax.print.attribute.IntegerSyntax
      javax.print.attribute.standard.NumberOfDocuments

All Implemented Interfaces:
PrintJobAttribute, Cloneable, Serializable

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

Constructor:

Constructor:
public NumberOfDocuments(int value) { super (value, 0, Integer.MAX_VALUE); } Construct a new number of documents attribute with the given integer value. Parameters: `value` - Integer value. Throws: `IllegalArgumentException` - (Unchecked exception) Thrown if `value` is less than 0. exception: `IllegalArgumentException` - (Unchecked exception) Thrown if `value` is less than 0.

 public NumberOfDocuments(int value) {
        super (value, 0, Integer.MAX_VALUE);
}

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

Parameters:

value - Integer value.

Throws:

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

exception: IllegalArgumentException - (Unchecked exception) Thrown if value is less than 0.

Method from javax.print.attribute.standard.NumberOfDocuments Summary:
equals, getCategory, getName

Methods from javax.print.attribute.IntegerSyntax:
equals, getValue, hashCode, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.print.attribute.standard.NumberOfDocuments Detail:
public boolean equals(Object object) { return (super.equals (object) && object instanceof NumberOfDocuments); } 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: `object` is not null. `object` is an instance of class NumberOfDocuments. This number of documents attribute's value and `object`'s value are equal.
public final Class<Attribute> getCategory() { return NumberOfDocuments.class; } 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.
public final String getName() { return "number-of-documents"; } Get the name of the category of which this attribute value is an instance. For class NumberOfDocuments, the category name is `"number-of-documents"`.

Method from javax.print.attribute.standard.NumberOfDocuments Detail:

 public boolean equals(Object object) {
        return (super.equals (object) &&
                object instanceof NumberOfDocuments);
}

object is not null.
object is an instance of class NumberOfDocuments.
This number of documents attribute's value and object's value are equal.

 public final Class<Attribute> getCategory() {
        return NumberOfDocuments.class;
}

For class NumberOfDocuments, the category is class NumberOfDocuments itself.

 public final String getName() {
        return "number-of-documents";
}

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