| /* |
| * 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.PrintJobAttribute; |
| |
| /** |
| * Class NumberOfDocuments is an integer valued printing attribute that |
| * indicates the number of individual docs the printer has accepted for this |
| * job, regardless of whether the docs' print data has reached the printer or |
| * not. |
| * <P> |
| * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The |
| * category name returned by <CODE>getName()</CODE> gives the IPP attribute |
| * name. |
| * <P> |
| * |
| * @author Alan Kaminsky |
| */ |
| public final class NumberOfDocuments extends IntegerSyntax |
| implements PrintJobAttribute { |
| |
| private static final long serialVersionUID = 7891881310684461097L; |
| |
| |
| /** |
| * Construct a new number of documents attribute with the given integer |
| * value. |
| * |
| * @param value Integer value. |
| * |
| * @exception IllegalArgumentException |
| * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0. |
| */ |
| public NumberOfDocuments(int value) { |
| super (value, 0, Integer.MAX_VALUE); |
| } |
| |
| /** |
| * Returns whether this number of documents attribute is equivalent to the |
| * passed in object. To be equivalent, all of the following conditions |
| * must be true: |
| * <OL TYPE=1> |
| * <LI> |
| * <CODE>object</CODE> is not null. |
| * <LI> |
| * <CODE>object</CODE> is an instance of class NumberOfDocuments. |
| * <LI> |
| * This number of documents attribute's value and <CODE>object</CODE>'s |
| * value are equal. |
| * </OL> |
| * |
| * @param object Object to compare to. |
| * |
| * @return True if <CODE>object</CODE> is equivalent to this number of |
| * documents attribute, false otherwise. |
| */ |
| public boolean equals(Object object) { |
| return (super.equals (object) && |
| object instanceof NumberOfDocuments); |
| } |
| |
| /** |
| * Get the printing attribute class which is to be used as the "category" |
| * for this printing attribute value. |
| * <P> |
| * For class NumberOfDocuments, the |
| * category is class NumberOfDocuments itself. |
| * |
| * @return Printing attribute class (category), an instance of class |
| * {@link java.lang.Class java.lang.Class}. |
| */ |
| public final Class<? extends Attribute> getCategory() { |
| return NumberOfDocuments.class; |
| } |
| |
| /** |
| * Get the name of the category of which this attribute value is an |
| * instance. |
| * <P> |
| * For class NumberOfDocuments, the |
| * category name is <CODE>"number-of-documents"</CODE>. |
| * |
| * @return Attribute category name. |
| */ |
| public final String getName() { |
| return "number-of-documents"; |
| } |
| |
| } |