Class NumberUpSupported
- java.lang.Object
-
- javax.print.attribute.SetOfIntegerSyntax
-
- javax.print.attribute.standard.NumberUpSupported
- All Implemented Interfaces:
-
Serializable
,Cloneable
,Attribute
,SupportedValuesAttribute
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 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 SetOfIntegerSyntax
for an explanation of canonical array form. The category name returned by getName()
gives the IPP attribute name.
- See Also:
- Serialized Form
Constructor Summary
Constructor | Description |
---|---|
NumberUpSupported(int member) | Construct a new number up supported attribute containing a single integer. |
NumberUpSupported(int[][] members) | Construct a new number up supported attribute with the given members. |
NumberUpSupported(int lowerBound,
int upperBound) | Construct a new number up supported attribute containing a single range of integers. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean | equals(Object object) | Returns whether this number up supported attribute is equivalent to the passed in object. |
Class<? extends Attribute> | getCategory() | Get the printing attribute class which is to be used as the "category" for this printing attribute value. |
String | getName() | Get the name of the category of which this attribute value is an instance. |
Methods declared in class javax.print.attribute.SetOfIntegerSyntax
contains, contains, getMembers, hashCode, next, toString
Methods declared in class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Constructor Detail
NumberUpSupported
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 SetOfIntegerSyntax
for an explanation of array form.
- Parameters:
-
members
- set members in array form - Throws:
-
NullPointerException
- ifmembers
isnull
or any element ofmembers
isnull
-
IllegalArgumentException
- if any element ofmembers
is not a length-one or length-two array. Also ifmembers
is a zero-length array or if any member of the set is less than 1.
NumberUpSupported
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.
- Parameters:
-
member
- set member - Throws:
-
IllegalArgumentException
- ifmember < 1
NumberUpSupported
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.
- Parameters:
-
lowerBound
- lower bound of the range -
upperBound
- upper bound of the range - Throws:
-
IllegalArgumentException
- if anull
range is specified or if anon-null
range is specified withlowerBound
less than 1
Method Detail
equals
public boolean equals(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:
-
object
is notnull
. -
object
is an instance of classNumberUpSupported
. - This number up supported attribute's members and
object
's members are the same.
- Overrides:
-
equals
in classSetOfIntegerSyntax
- Parameters:
-
object
-Object
to compare to - Returns:
-
true
ifobject
is equivalent to this number up supported attribute,false
otherwise - See Also:
-
Object.hashCode()
,HashMap
getCategory
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 NumberUpSupported
, the category is class NumberUpSupported
itself.
- Specified by:
-
getCategory
in interfaceAttribute
- Returns:
- printing attribute class (category), an instance of class
java.lang.Class
getName
public final String getName()
Get the name of the category of which this attribute value is an instance.
For class NumberUpSupported
, the category name is "number-up-supported"
.