APIdia Launch Partner
Top Description Fields Constructors Methods
javax.print.attribute.standard

public final Class Copies

extends IntegerSyntax
implements PrintRequestAttribute, PrintJobAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.PrintJobAttribute, javax.print.attribute.Attribute, java.io.Serializable, javax.print.attribute.PrintRequestAttribute
Imports
java.io.Serial, javax.print.attribute.Attribute, .IntegerSyntax, .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 MultipleDocumentHandling attribute:

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

Authors
David Mendenhall, Alan Kamihensky

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.print.attribute.IntegerSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
Copies(int
Integer value
value
)

Construct a new copies attribute with the given integer value.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if object is equivalent to this copies attribute, false otherwise
equals
(Object
Object to compare to
object
)

Overrides javax.print.attribute.IntegerSyntax.equals.

Returns whether this copies attribute is equivalent to the passed in object.

public final Class<? extends Attribute>

Returns:

printing attribute class (category), an instance of class java.lang.Class
getCategory
()

Implements javax.print.attribute.Attribute.getCategory.

Get the printing attribute class which is to be used as the "category" for this printing attribute value.

public final String

Returns:

attribute category name
getName
()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

Inherited from javax.print.attribute.IntegerSyntax:
getValuehashCodetoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.IntegerSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

Copiesback to summary
public Copies(int value)

Construct a new copies attribute with the given integer value.

Parameters
value:int

Integer value

Exceptions
IllegalArgumentException:
if value < 1

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.IntegerSyntax.equals.

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.
Parameters
object:Object

Object to compare to

Returns:boolean

true if object is equivalent to this copies attribute, false otherwise

Annotations
@Override
getCategoryback to summary
public final Class<? extends Attribute> getCategory()

Implements 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 Copies, the category is class Copies itself.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations
@Override
getNameback to summary
public final String getName()

Implements javax.print.attribute.Attribute.getName.

Get the name of the category of which this attribute value is an instance.

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

Returns:String

attribute category name

Annotations
@Override