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

public final Class NumberUpSupported

extends SetOfIntegerSyntax
implements SupportedValuesAttribute
Class Inheritance
All Implemented Interfaces
javax.print.attribute.SupportedValuesAttribute, javax.print.attribute.Attribute, java.io.Serializable
Imports
java.io.Serial, javax.print.attribute.Attribute, .SetOfIntegerSyntax, .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.

Author
Alan Kaminsky

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides javax.print.attribute.SetOfIntegerSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Constructor Summary

AccessConstructor and Description
public
NumberUpSupported(int[][]
set members in array form
members)

Construct a new number up supported attribute with the given members.

public
NumberUpSupported(int
set member
member)

Construct a new number up supported attribute containing a single integer.

public
NumberUpSupported(int
lower bound of the range
lowerBound, int
upper bound of the range
upperBound)

Construct a new number up supported attribute containing a single range of integers.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

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

Overrides javax.print.attribute.SetOfIntegerSyntax.equals.

Returns whether this number up supported 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.SetOfIntegerSyntax:
containscontainsgetMembershashCodenexttoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides javax.print.attribute.SetOfIntegerSyntax.serialVersionUID.

Use serialVersionUID from JDK 1.4 for interoperability.

Annotations
@Serial

Constructor Detail

NumberUpSupportedback to 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 SetOfIntegerSyntax for an explanation of array form.

Parameters
members:int[][]

set members in array form

Exceptions
NullPointerException:
if members is null or any element of members is null
IllegalArgumentException:
if any element of members is not a length-one or length-two array. Also if members is a zero-length array or if any member of the set is less than 1.
NumberUpSupportedback to summary
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:int

set member

Exceptions
IllegalArgumentException:
if member < 1
NumberUpSupportedback to summary
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:int

lower bound of the range

upperBound:int

upper bound of the range

Exceptions
IllegalArgumentException:
if a null range is specified or if a non-null range is specified with lowerBound less than 1

Method Detail

equalsback to summary
public boolean equals(Object object)

Overrides javax.print.attribute.SetOfIntegerSyntax.equals.

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

Object to compare to

Returns:boolean

true if object is equivalent to this number up supported 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 NumberUpSupported, the category is class NumberUpSupported 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 NumberUpSupported, the category name is "number-up-supported".

Returns:String

attribute category name

Annotations
@Override