1 /* 2 * Copyright (c) 2000, 2004, 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 java.util.Locale; 28 import javax.print.attribute.Attribute; 29 import javax.print.attribute.TextSyntax; 30 import javax.print.attribute.PrintServiceAttribute; 31 32 /** 33 * Class PrinterMakeAndModel is a printing attribute class, a text attribute, 34 * that the make and model of the printer. 35 * <P> 36 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The 37 * locale gives the IPP natural language. The category name returned by 38 * <CODE>getName()</CODE> gives the IPP attribute name. 39 * <P> 40 * 41 * @author Alan Kaminsky 42 */ 43 public final class PrinterMakeAndModel extends TextSyntax 44 implements PrintServiceAttribute { 45 46 private static final long serialVersionUID = 4580461489499351411L; 47 48 /** 49 * Constructs a new printer make and model attribute with the given make 50 * and model string and locale. 51 * 52 * @param makeAndModel Printer make and model string. 53 * @param locale Natural language of the text string. null 54 * is interpreted to mean the default locale as returned 55 * by <code>Locale.getDefault()</code> 56 * 57 * @exception NullPointerException 58 * (unchecked exception) Thrown if <CODE>makeAndModel</CODE> is null. 59 */ 60 public PrinterMakeAndModel(String makeAndModel, Locale locale) { 61 super (makeAndModel, locale); 62 } 63 64 /** 65 * Returns whether this printer make and model attribute is equivalent to 66 * the passed in object. To be equivalent, all of the following conditions 67 * must be true: 68 * <OL TYPE=1> 69 * <LI> 70 * <CODE>object</CODE> is not null. 71 * <LI> 72 * <CODE>object</CODE> is an instance of class PrinterMakeAndModel. 73 * <LI> 74 * This printer make and model attribute's underlying string and 75 * <CODE>object</CODE>'s underlying string are equal. 76 * <LI> 77 * This printer make and model attribute's locale and 78 * <CODE>object</CODE>'s locale are equal. 79 * </OL> 80 * 81 * @param object Object to compare to. 82 * 83 * @return True if <CODE>object</CODE> is equivalent to this printer 84 * make and model attribute, false otherwise. 85 */ 86 public boolean equals(Object object) { 87 return (super.equals(object) && 88 object instanceof PrinterMakeAndModel); 89 } 90 91 /** 92 * Get the printing attribute class which is to be used as the "category" 93 * for this printing attribute value. 94 * <P> 95 * For class PrinterMakeAndModel, the 96 * category is class PrinterMakeAndModel itself. 97 * 98 * @return Printing attribute class (category), an instance of class 99 * {@link java.lang.Class java.lang.Class}. 100 */ 101 public final Class<? extends Attribute> getCategory() { 102 return PrinterMakeAndModel.class; 103 } 104 105 /** 106 * Get the name of the category of which this attribute value is an 107 * instance. 108 * <P> 109 * For class PrinterMakeAndModel, the 110 * category name is <CODE>"printer-make-and-model"</CODE>. 111 * 112 * @return Attribute category name. 113 */ 114 public final String getName() { 115 return "printer-make-and-model"; 116 } 117 118 }