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

CopiesSupported

public final class CopiesSupported extends SetOfIntegerSyntax implements SupportedValuesAttribute
Class CopiesSupported is a printing attribute class, a set of integers, that gives the supported values for a {@link Copies 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 {@link javax.print.attribute.SetOfIntegerSyntax SetOfIntegerSyntax} for an explanation of canonical array form. The category name returned by getName() gives the IPP attribute name.

author
Alan Kaminsky

Fields Summary
private static final long
serialVersionUID
Constructors Summary
public CopiesSupported(int member)
Construct a new copies supported attribute containing a single integer. That is, only the one value of Copies is supported.

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


                                                  
       
	super (member);
	if (member < 1) {
	    throw new IllegalArgumentException("Copies value < 1 specified");
	}
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.

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

 
	super(lowerBound, upperBound);
	
	if (lowerBound > upperBound) {
	    throw new IllegalArgumentException("Null range specified");
	} else if (lowerBound < 1) {
	    throw new IllegalArgumentException("Copies value < 1 specified");
	}
Methods Summary
public booleanequals(java.lang.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.

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

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

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

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

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

return
Attribute category name.

	return "copies-supported";