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

Copies

public final class Copies extends IntegerSyntax implements PrintJobAttribute, PrintRequestAttribute
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 {@link MultipleDocumentHandling 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

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public Copies(int value)
Construct a new copies attribute with the given integer value.

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


                                       
       
	super (value, 1, Integer.MAX_VALUE);
    
Methods Summary
public booleanequals(java.lang.Object object)
Returns whether this copies 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 Copies.
  3. This copies attribute's value and object's value are equal.

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

	return super.equals (object) && object instanceof Copies;
    
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 Copies, the category is class Copies itself.

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

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

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

return
Attribute category name.

	return "copies";