public final class

CopiesSupported

extends SetOfIntegerSyntax
implements SupportedValuesAttribute
java.lang.Object
   ↳ javax.print.attribute.SetOfIntegerSyntax
     ↳ javax.print.attribute.standard.CopiesSupported

Class Overview

Class CopiesSupported is a printing attribute class, a set of integers, that gives the supported values for a Copies attribute. It is restricted to a single contiguous range of integers; multiple non-overlapping ranges are not allowed.

IPP Compatibility: The CopiesSupported attribute's canonical array form gives the lower and upper bound for the range of copies to be included in an IPP "copies-supported" attribute. See class SetOfIntegerSyntax for an explanation of canonical array form. The category name returned by getName() gives the IPP attribute name.

Summary

Public Constructors
CopiesSupported(int member)
Construct a new copies supported attribute containing a single integer.
CopiesSupported(int lowerBound, int upperBound)
Construct a new copies supported attribute containing a single range of integers.
Public Methods
boolean equals(Object object)
Returns whether this copies supported attribute is equivalent to the passed in object.
final Class<? extends Attribute> getCategory()
Get the printing attribute class which is to be used as the "category" for this printing attribute value.
final String getName()
Get the name of the category of which this attribute value is an instance.
[Expand]
Inherited Methods
From class javax.print.attribute.SetOfIntegerSyntax
From class java.lang.Object
From interface javax.print.attribute.Attribute

Public Constructors

public CopiesSupported (int member)

Construct a new copies supported attribute containing a single integer. That is, only the one value of Copies is supported.

Parameters
member Set member.
Throws
IllegalArgumentException (Unchecked exception) Thrown if member is less than 1.

public CopiesSupported (int lowerBound, int upperBound)

Construct a new copies supported attribute containing a single range of integers. That is, only those values of Copies in the one range are supported.

Parameters
lowerBound Lower bound of the range.
upperBound Upper bound of the range.
Throws
IllegalArgumentException (Unchecked exception) Thrown if a null range is specified or if a non-null range is specified with lowerBound less than 1.

Public Methods

public boolean equals (Object object)

Returns whether this copies supported 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 CopiesSupported.
  3. This copies supported attribute's members and object's members are the same.

Parameters
object Object to compare to.
Returns
  • True if object is equivalent to this copies supported attribute, false otherwise.

public final Class<? extends Attribute> getCategory ()

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

For class CopiesSupported, the category is class CopiesSupported itself.

Returns
  • Printing attribute class (category), an instance of class java.lang.Class.

public final String getName ()

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

For class CopiesSupported, the category name is "copies-supported".

Returns
  • Attribute category name.