/* * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.print.attribute.standard; import javax.print.attribute.Attribute; import javax.print.attribute.IntegerSyntax; import javax.print.attribute.DocAttribute; import javax.print.attribute.PrintRequestAttribute; import javax.print.attribute.PrintJobAttribute; /** * 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 {@link * MultipleDocumentHandling MultipleDocumentHandling} attribute. *

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

* * @author Alan Kaminsky */ public final class NumberUp extends IntegerSyntax implements DocAttribute, PrintRequestAttribute, PrintJobAttribute { private static final long serialVersionUID = -3040436486786527811L; /** * Construct a new number up attribute with the given integer value. * * @param value Integer value. * * @exception IllegalArgumentException * (Unchecked exception) Thrown if value is less than 1. */ public NumberUp(int value) { super (value, 1, Integer.MAX_VALUE); } /** * Returns whether this number up 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 NumberUp. *
  3. * This number up attribute's value and object's value are * equal. *
* * @param object Object to compare to. * * @return True if object is equivalent to this number up * attribute, false otherwise. */ public boolean equals(Object object) { return (super.equals(object) && object instanceof NumberUp); } /** * 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. * * @return Printing attribute class (category), an instance of class * {@link java.lang.Class java.lang.Class}. */ public final Class getCategory() { return NumberUp.class; } /** * Get the name of the category of which this attribute value is an * instance. *

* For class NumberUp, the category name is "number-up". * * @return Attribute category name. */ public final String getName() { return "number-up"; } }