OpenJDK 27 · javax.print.attribute.standard.NumberUp

Class NumberUp is an integer valued printing attribute class that specifies the number of print-stream pages to impose upon a single side of an instance of a selected medium. That is, if the NumberUp value is n, the printer must place n print-stream pages on a single side of an instance of the selected medium. To accomplish this, the printer may add some sort of translation, scaling, or rotation. This attribute primarily controls the translation, scaling and rotation of print-stream pages.

The effect of a NumberUp attribute on a multidoc print job (a job with multiple documents) depends on whether all the docs have the same number up values specified or whether different docs have different number up values specified, and on the (perhaps defaulted) value of the MultipleDocumentHandling attribute.

If all the docs have the same number up value n specified, then any value of MultipleDocumentHandling makes sense, and the printer's processing depends on the MultipleDocumentHandling value:
- SINGLE_DOCUMENT -- All the input docs will be combined together into one output document. Each media impression will consist of nm print-stream pages from the output document.
- SINGLE_DOCUMENT_NEW_SHEET -- All the input docs will be combined together into one output document. Each media impression will consist of n print-stream pages from the output document. However, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n print-stream pages on it.
- SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- The input docs will remain separate. Each media impression will consist of n print-stream pages from the input doc. Since the input docs are separate, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n print-stream pages on it.
- SEPARATE_DOCUMENTS_COLLATED_COPIES -- The input docs will remain separate. Each media impression will consist of n print-stream pages from the input doc. Since the input docs are separate, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n print-stream pages on it.
- SINGLE_DOCUMENT -- All the input docs will be combined together into one output document. Each media impression will consist of n_i print-stream pages from the output document, where i is the number of the input doc corresponding to that point in the output document. When the next input doc has a different number up value from the previous input doc, the first print-stream page of the next input doc goes at the start of the next media impression, possibly leaving fewer than the full number of print-stream pages on the previous media impression.
- SINGLE_DOCUMENT_NEW_SHEET -- All the input docs will be combined together into one output document. Each media impression will consist of n print-stream pages from the output document. However, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n print-stream pages on it.
- SEPARATE_DOCUMENTS_UNCOLLATED_COPIES -- The input docs will remain separate. For input doc i, each media impression will consist of n_i print-stream pages from the input doc. Since the input docs are separate, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n_i print-stream pages on it.
- SEPARATE_DOCUMENTS_COLLATED_COPIES -- The input docs will remain separate. For input doc i, each media impression will consist of n_i print-stream pages from the input doc. Since the input docs are separate, the first impression of each input doc will always start on a new media sheet; this means the last impression of an input doc may have fewer than n_i print-stream pages on it.

IPP Compatibility: The integer value gives the IPP integer value. The category name returned by getName() gives the IPP attribute name.

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides javax.print.attribute.IntegerSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability.

Access	Constructor and Description
public	NumberUp(int Integer value value) Construct a new number up attribute with the given integer value.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if `object` is equivalent to this number up attribute, `false` otherwise equals(Object `Object` to compare to object) Overrides javax.print.attribute.IntegerSyntax.equals. Returns whether this number up 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.IntegerSyntax:: getValue hashCode toString

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.print.attribute.IntegerSyntax.serialVersionUID. Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

NumberUp	back to summary
public NumberUp(int value) Construct a new number up attribute with the given integer value. Parameters value:int Integer value Exceptions IllegalArgumentException: if `value < 1`

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides javax.print.attribute.IntegerSyntax.equals. Returns whether this number up attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true: `object` is not `null`. `object` is an instance of class `NumberUp`. This number up attribute's value and `object`'s value are equal. Parameters object:Object `Object` to compare to Returns:boolean `true` if `object` is equivalent to this number up attribute, `false` otherwise Annotations @Override

public boolean equals(Object object)

Overrides javax.print.attribute.IntegerSyntax.equals.

Returns whether this number up attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:

object is not null.
object is an instance of class NumberUp.
This number up attribute's value and object's value are equal.

Parameters

object:Object: Object to compare to

Returns:boolean

true if object is equivalent to this number up attribute, false otherwise

Annotations

@Override

getCategory back to summary

getCategory	back 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 `NumberUp`, the category is class `NumberUp` itself. Returns:Class<? extends Attribute> printing attribute class (category), an instance of class `java.lang.Class` Annotations @Override

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 NumberUp, the category is class NumberUp itself.

Returns:Class<? extends Attribute>

printing attribute class (category), an instance of class java.lang.Class

Annotations

@Override

getName back to summary

getName	back 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 `NumberUp`, the category name is `"number-up"`. Returns:String attribute category name Annotations @Override

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 NumberUp, the category name is "number-up".

Returns:String

attribute category name

Annotations

@Override

public final Class NumberUp

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail