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.PrintJobAttribute;
032
033 /**
034 * Class OutputDeviceAssigned is a printing attribute class, a text attribute,
035 * that identifies the output device to which the service has assigned this
036 * job. If an output device implements an embedded Print Service instance, the
037 * printer need not set this attribute. If a print server implements a
038 * Print Service instance, the value may be empty (zero- length string) or not
039 * returned until the service assigns an output device to the job. This
040 * attribute is particularly useful when a single service supports multiple
041 * devices (so called "fan-out").
042 * <P>
043 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
044 * locale gives the IPP natural language. The category name returned by
045 * <CODE>getName()</CODE> gives the IPP attribute name.
046 * <P>
047 *
048 * @author Alan Kaminsky
049 */
050 public final class OutputDeviceAssigned extends TextSyntax implements
051 PrintJobAttribute {
052
053 private static final long serialVersionUID = 5486733778854271081L;
054
055 /**
056 * Constructs a new output device assigned attribute with the given device
057 * name and locale.
058 *
059 * @param deviceName Device name.
060 * @param locale Natural language of the text string. null
061 * is interpreted to mean the default locale as returned
062 * by <code>Locale.getDefault()</code>
063 *
064 * @exception NullPointerException
065 * (unchecked exception) Thrown if <CODE>deviceName</CODE> is null.
066 */
067 public OutputDeviceAssigned(String deviceName, Locale locale) {
068
069 super (deviceName, locale);
070 }
071
072 // Exported operations inherited and overridden from class Object.
073
074 /**
075 * Returns whether this output device assigned attribute is equivalent to
076 * the passed in object. To be equivalent, all of the following conditions
077 * must be true:
078 * <OL TYPE=1>
079 * <LI>
080 * <CODE>object</CODE> is not null.
081 * <LI>
082 * <CODE>object</CODE> is an instance of class OutputDeviceAssigned.
083 * <LI>
084 * This output device assigned attribute's underlying string and
085 * <CODE>object</CODE>'s underlying string are equal.
086 * <LI>
087 * This output device assigned attribute's locale and
088 * <CODE>object</CODE>'s locale are equal.
089 * </OL>
090 *
091 * @param object Object to compare to.
092 *
093 * @return True if <CODE>object</CODE> is equivalent to this output
094 * device assigned attribute, false otherwise.
095 */
096 public boolean equals(Object object) {
097 return (super .equals(object) && object instanceof OutputDeviceAssigned);
098 }
099
100 /**
101 * Get the printing attribute class which is to be used as the "category"
102 * for this printing attribute value.
103 * <P>
104 * For class OutputDeviceAssigned, the
105 * category is class OutputDeviceAssigned itself.
106 *
107 * @return Printing attribute class (category), an instance of class
108 * {@link java.lang.Class java.lang.Class}.
109 */
110 public final Class<? extends Attribute> getCategory() {
111 return OutputDeviceAssigned.class;
112 }
113
114 /**
115 * Get the name of the category of which this attribute value is an
116 * instance.
117 * <P>
118 * For class OutputDeviceAssigned, the
119 * category name is <CODE>"output-device-assigned"</CODE>.
120 *
121 * @return Attribute category name.
122 */
123 public final String getName() {
124 return "output-device-assigned";
125 }
126
127 }
|