001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import java.util.Locale;
028 import javax.print.attribute.Attribute;
029 import javax.print.attribute.TextSyntax;
030 import javax.print.attribute.PrintServiceAttribute;
031
032 /**
033 * Class PrinterMakeAndModel is a printing attribute class, a text attribute,
034 * that the make and model of the printer.
035 * <P>
036 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
037 * locale gives the IPP natural language. The category name returned by
038 * <CODE>getName()</CODE> gives the IPP attribute name.
039 * <P>
040 *
041 * @author Alan Kaminsky
042 */
043 public final class PrinterMakeAndModel extends TextSyntax implements
044 PrintServiceAttribute {
045
046 private static final long serialVersionUID = 4580461489499351411L;
047
048 /**
049 * Constructs a new printer make and model attribute with the given make
050 * and model string and locale.
051 *
052 * @param makeAndModel Printer make and model string.
053 * @param locale Natural language of the text string. null
054 * is interpreted to mean the default locale as returned
055 * by <code>Locale.getDefault()</code>
056 *
057 * @exception NullPointerException
058 * (unchecked exception) Thrown if <CODE>makeAndModel</CODE> is null.
059 */
060 public PrinterMakeAndModel(String makeAndModel, Locale locale) {
061 super (makeAndModel, locale);
062 }
063
064 /**
065 * Returns whether this printer make and model attribute is equivalent to
066 * the passed in object. To be equivalent, all of the following conditions
067 * must be true:
068 * <OL TYPE=1>
069 * <LI>
070 * <CODE>object</CODE> is not null.
071 * <LI>
072 * <CODE>object</CODE> is an instance of class PrinterMakeAndModel.
073 * <LI>
074 * This printer make and model attribute's underlying string and
075 * <CODE>object</CODE>'s underlying string are equal.
076 * <LI>
077 * This printer make and model attribute's locale and
078 * <CODE>object</CODE>'s locale are equal.
079 * </OL>
080 *
081 * @param object Object to compare to.
082 *
083 * @return True if <CODE>object</CODE> is equivalent to this printer
084 * make and model attribute, false otherwise.
085 */
086 public boolean equals(Object object) {
087 return (super .equals(object) && object instanceof PrinterMakeAndModel);
088 }
089
090 /**
091 * Get the printing attribute class which is to be used as the "category"
092 * for this printing attribute value.
093 * <P>
094 * For class PrinterMakeAndModel, the
095 * category is class PrinterMakeAndModel itself.
096 *
097 * @return Printing attribute class (category), an instance of class
098 * {@link java.lang.Class java.lang.Class}.
099 */
100 public final Class<? extends Attribute> getCategory() {
101 return PrinterMakeAndModel.class;
102 }
103
104 /**
105 * Get the name of the category of which this attribute value is an
106 * instance.
107 * <P>
108 * For class PrinterMakeAndModel, the
109 * category name is <CODE>"printer-make-and-model"</CODE>.
110 *
111 * @return Attribute category name.
112 */
113 public final String getName() {
114 return "printer-make-and-model";
115 }
116
117 }
|