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
029 import javax.print.attribute.Attribute;
030 import javax.print.attribute.TextSyntax;
031 import javax.print.attribute.PrintServiceAttribute;
032
033 /**
034 * Class PrinterLocation is a printing attribute class, a text attribute, that
035 * identifies the location of the device. This could include things like:
036 * <CODE>"in Room 123A, second floor of building XYZ"</CODE>.
037 * <P>
038 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
039 * locale gives the IPP natural language. The category name returned by
040 * <CODE>getName()</CODE> gives the IPP attribute name.
041 * <P>
042 *
043 * @author Alan Kaminsky
044 */
045 public final class PrinterLocation extends TextSyntax implements
046 PrintServiceAttribute {
047
048 private static final long serialVersionUID = -1598610039865566337L;
049
050 /**
051 * Constructs a new printer location attribute with the given location and
052 * locale.
053 *
054 * @param location Printer location.
055 * @param locale Natural language of the text string. null
056 * is interpreted to mean the default locale as returned
057 * by <code>Locale.getDefault()</code>
058 *
059 * @exception NullPointerException
060 * (unchecked exception) Thrown if <CODE>location</CODE> is null.
061 */
062 public PrinterLocation(String location, Locale locale) {
063 super (location, locale);
064 }
065
066 /**
067 * Returns whether this printer location attribute is equivalent to the
068 * passed in object. To be equivalent, all of the following conditions
069 * must be true:
070 * <OL TYPE=1>
071 * <LI>
072 * <CODE>object</CODE> is not null.
073 * <LI>
074 * <CODE>object</CODE> is an instance of class PrinterLocation.
075 * <LI>
076 * This printer location attribute's underlying string and
077 * <CODE>object</CODE>'s underlying string are equal.
078 * <LI>
079 * This printer location attribute's locale and <CODE>object</CODE>'s
080 * locale are equal.
081 * </OL>
082 *
083 * @param object Object to compare to.
084 *
085 * @return True if <CODE>object</CODE> is equivalent to this printer
086 * location attribute, false otherwise.
087 */
088 public boolean equals(Object object) {
089 return (super .equals(object) && object instanceof PrinterLocation);
090 }
091
092 /**
093 * Get the printing attribute class which is to be used as the "category"
094 * for this printing attribute value.
095 * <P>
096 * For class PrinterLocation, the
097 * category is class PrinterLocation itself.
098 *
099 * @return Printing attribute class (category), an instance of class
100 * {@link java.lang.Class java.lang.Class}.
101 */
102 public final Class<? extends Attribute> getCategory() {
103 return PrinterLocation.class;
104 }
105
106 /**
107 * Get the name of the category of which this attribute value is an
108 * instance.
109 * <P>
110 * For class PrinterLocation, the
111 * category name is <CODE>"printer-location"</CODE>.
112 *
113 * @return Attribute category name.
114 */
115 public final String getName() {
116 return "printer-location";
117 }
118
119 }
|