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

NumberUpSupported

public final class NumberUpSupported extends SetOfIntegerSyntax implements SupportedValuesAttribute
Class NumberUpSupported is a printing attribute class, a set of integers, that gives the supported values for a {@link NumberUp NumberUp} attribute.

IPP Compatibility: The NumberUpSupported attribute's canonical array form gives the lower and upper bound for each range of number-up to be included in an IPP "number-up-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 NumberUpSupported(int[] members)
Construct a new number up supported attribute with the given members. The supported values for NumberUp are specified in "array form;" see class {@link javax.print.attribute.SetOfIntegerSyntax SetOfIntegerSyntax} for an explanation of array form.

param
members Set members in array form.
exception
NullPointerException (unchecked exception) Thrown if members is null or any element of members is null.
exception
IllegalArgumentException (unchecked exception) Thrown if any element of members is not a length-one or length-two array. Also thrown if members is a zero-length array or if any member of the set is less than 1.



                                                                                                                                      
       
	super (members);
	if (members == null) {
	    throw new NullPointerException("members is null");
	}
	int[][] myMembers = getMembers();
	int n = myMembers.length;
	if (n == 0) {
	    throw new IllegalArgumentException("members is zero-length");
	}
	int i;
	for (i = 0; i < n; ++ i) {
	    if (myMembers[i][0] < 1) {
		throw new IllegalArgumentException
		    ("Number up value must be > 0");
	    }
	}
    
public NumberUpSupported(int member)
Construct a new number up supported attribute containing a single integer. That is, only the one value of NumberUp 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("Number up value must be > 0");
	}
    
public NumberUpSupported(int lowerBound, int upperBound)
Construct a new number up supported attribute containing a single range of integers. That is, only those values of NumberUp 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
		("Number up value must be > 0");
	}
    
Methods Summary
public booleanequals(java.lang.Object object)
Returns whether this number up 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 NumberUpSupported.
  3. This number up 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 number up supported attribute, false otherwise.

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

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

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

For class NumberUpSupported, the category name is "number-up-supported".

return
Attribute category name.

	return "number-up-supported";