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

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

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

All Implemented Interfaces:
PrintJobAttribute, PrintRequestAttribute, Cloneable, Serializable

Class Copies is an integer valued printing attribute class that specifies the number of copies to be printed.

On many devices the supported number of collated copies will be limited by the number of physical output bins on the device, and may be different from the number of uncollated copies which can be supported.

The effect of a Copies attribute with a value of n on a multidoc print job (a job with multiple documents) depends on the (perhaps defaulted) value of the MultipleDocumentHandling attribute:

SINGLE_DOCUMENT -- The result will be n copies of a single output document comprising all the input docs.
SINGLE_DOCUMENT_NEW_SHEET -- The result will be n copies of a single output document comprising all the input docs, and the first impression of each input doc will always start on a new media sheet.
SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- The result will be n copies of the first input document, followed by n copies of the second input document, . . . followed by n copies of the last input document.
SEPARATE_DOCUMENTS_COLLATED_COPIES -- The result will be the first input document, the second input document, . . . the last input document, the group of documents being repeated n times.

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

author: David - Mendenhall

author: Alan - Kamihensky

Constructor:

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

 public Copies(int value) {
        super (value, 1, Integer.MAX_VALUE);
}

Construct a new copies attribute with the given integer value.

Parameters:

value - Integer value.

Throws:

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

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

Method from javax.print.attribute.standard.Copies 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.Copies Detail:
public boolean equals(Object object) { return super.equals (object) && object instanceof Copies; } Returns whether this copies 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 Copies. This copies attribute's value and `object`'s value are equal.
public final Class<Attribute> getCategory() { return Copies.class; } Get the printing attribute class which is to be used as the "category" for this printing attribute value. For class Copies, the category is class Copies itself.
public final String getName() { return "copies"; } Get the name of the category of which this attribute value is an instance. For class Copies, the category name is `"copies"`.

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

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

object is not null.
object is an instance of class Copies.
This copies attribute's value and object's value are equal.

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

For class Copies, the category is class Copies itself.

 public final String getName() {
        return "copies";
}

For class Copies, the category name is "copies".