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