1 /* 2 * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 package javax.print.attribute.standard; 26 27 import javax.print.attribute.Attribute; 28 import javax.print.attribute.IntegerSyntax; 29 import javax.print.attribute.PrintJobAttribute; 30 31 /** 32 * Class NumberOfDocuments is an integer valued printing attribute that 33 * indicates the number of individual docs the printer has accepted for this 34 * job, regardless of whether the docs' print data has reached the printer or 35 * not. 36 * <P> 37 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The 38 * category name returned by {@code getName()} gives the IPP attribute 39 * name. 40 * 41 * @author Alan Kaminsky 42 */ 43 public final class NumberOfDocuments extends IntegerSyntax 44 implements PrintJobAttribute { 45 46 private static final long serialVersionUID = 7891881310684461097L; 47 48 49 /** 50 * Construct a new number of documents attribute with the given integer 51 * value. 52 * 53 * @param value Integer value. 54 * 55 * @exception IllegalArgumentException 56 * (Unchecked exception) Thrown if {@code value} is less than 0. 57 */ 58 public NumberOfDocuments(int value) { 59 super (value, 0, Integer.MAX_VALUE); 60 } 61 62 /** 63 * Returns whether this number of documents attribute is equivalent to the 64 * passed in object. To be equivalent, all of the following conditions 65 * must be true: 66 * <OL TYPE=1> 67 * <LI> 68 * {@code object} is not null. 69 * <LI> 70 * {@code object} is an instance of class NumberOfDocuments. 71 * <LI> 72 * This number of documents attribute's value and {@code object}'s 73 * value are equal. 74 * </OL> 75 * 76 * @param object Object to compare to. 77 * 78 * @return True if {@code object} is equivalent to this number of 79 * documents attribute, false otherwise. 80 */ 81 public boolean equals(Object object) { 82 return (super.equals (object) && 83 object instanceof NumberOfDocuments); 84 } 85 86 /** 87 * Get the printing attribute class which is to be used as the "category" 88 * for this printing attribute value. 89 * <P> 90 * For class NumberOfDocuments, the 91 * category is class NumberOfDocuments itself. 92 * 93 * @return Printing attribute class (category), an instance of class 94 * {@link java.lang.Class java.lang.Class}. 95 */ 96 public final Class<? extends Attribute> getCategory() { 97 return NumberOfDocuments.class; 98 } 99 100 /** 101 * Get the name of the category of which this attribute value is an 102 * instance. 103 * <P> 104 * For class NumberOfDocuments, the 105 * category name is {@code "number-of-documents"}. 106 * 107 * @return Attribute category name. 108 */ 109 public final String getName() { 110 return "number-of-documents"; 111 } 112 113 } | 1 /* 2 * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package javax.print.attribute.standard; 27 28 import javax.print.attribute.Attribute; 29 import javax.print.attribute.IntegerSyntax; 30 import javax.print.attribute.PrintJobAttribute; 31 32 /** 33 * Class {@code NumberOfDocuments} is an integer valued printing attribute that 34 * indicates the number of individual docs the printer has accepted for this 35 * job, regardless of whether the docs' print data has reached the printer or 36 * not. 37 * <p> 38 * <b>IPP Compatibility:</b> The integer value gives the IPP integer value. The 39 * category name returned by {@code getName()} gives the IPP attribute name. 40 * 41 * @author Alan Kaminsky 42 */ 43 public final class NumberOfDocuments extends IntegerSyntax 44 implements PrintJobAttribute { 45 46 /** 47 * Use serialVersionUID from JDK 1.4 for interoperability. 48 */ 49 private static final long serialVersionUID = 7891881310684461097L; 50 51 /** 52 * Construct a new number of documents attribute with the given integer 53 * value. 54 * 55 * @param value Integer value 56 * @throws IllegalArgumentException if {@code value} is negative 57 */ 58 public NumberOfDocuments(int value) { 59 super (value, 0, Integer.MAX_VALUE); 60 } 61 62 /** 63 * Returns whether this number of documents attribute is equivalent to the 64 * passed in object. To be equivalent, all of the following conditions must 65 * be true: 66 * <ol type=1> 67 * <li>{@code object} is not {@code null}. 68 * <li>{@code object} is an instance of class {@code NumberOfDocuments}. 69 * <li>This number of documents attribute's value and {@code object}'s 70 * value are equal. 71 * </ol> 72 * 73 * @param object {@code Object} to compare to 74 * @return {@code true} if {@code object} is equivalent to this number of 75 * documents attribute, {@code false} otherwise 76 */ 77 public boolean equals(Object object) { 78 return (super.equals (object) && 79 object instanceof NumberOfDocuments); 80 } 81 82 /** 83 * Get the printing attribute class which is to be used as the "category" 84 * for this printing attribute value. 85 * <p> 86 * For class {@code NumberOfDocuments}, the category is class 87 * {@code NumberOfDocuments} itself. 88 * 89 * @return printing attribute class (category), an instance of class 90 * {@link Class java.lang.Class} 91 */ 92 public final Class<? extends Attribute> getCategory() { 93 return NumberOfDocuments.class; 94 } 95 96 /** 97 * Get the name of the category of which this attribute value is an 98 * instance. 99 * <p> 100 * For class {@code NumberOfDocuments}, the category name is 101 * {@code "number-of-documents"}. 102 * 103 * @return attribute category name 104 */ 105 public final String getName() { 106 return "number-of-documents"; 107 } 108 } |