1 /*
2 * Copyright 2000-2004 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any 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.PrintJobAttribute;
32
33 /**
34 * Class OutputDeviceAssigned is a printing attribute class, a text attribute,
35 * that identifies the output device to which the service has assigned this
36 * job. If an output device implements an embedded Print Service instance, the
37 * printer need not set this attribute. If a print server implements a
38 * Print Service instance, the value may be empty (zero- length string) or not
39 * returned until the service assigns an output device to the job. This
40 * attribute is particularly useful when a single service supports multiple
41 * devices (so called "fan-out").
42 * <P>
43 * <B>IPP Compatibility:</B> The string value gives the IPP name value. The
44 * locale gives the IPP natural language. The category name returned by
45 * <CODE>getName()</CODE> gives the IPP attribute name.
46 * <P>
47 *
48 * @author Alan Kaminsky
49 */
50 public final class OutputDeviceAssigned extends TextSyntax
51 implements PrintJobAttribute {
52
53 private static final long serialVersionUID = 5486733778854271081L;
54
55 /**
56 * Constructs a new output device assigned attribute with the given device
57 * name and locale.
58 *
59 * @param deviceName Device name.
60 * @param locale Natural language of the text string. null
61 * is interpreted to mean the default locale as returned
62 * by <code>Locale.getDefault()</code>
63 *
64 * @exception NullPointerException
65 * (unchecked exception) Thrown if <CODE>deviceName</CODE> is null.
66 */
67 public OutputDeviceAssigned(String deviceName, Locale locale) {
68
69 super (deviceName, locale);
70 }
71
72 // Exported operations inherited and overridden from class Object.
73
74 /**
75 * Returns whether this output device assigned attribute is equivalent to
76 * the passed in object. To be equivalent, all of the following conditions
77 * must be true:
78 * <OL TYPE=1>
79 * <LI>
80 * <CODE>object</CODE> is not null.
81 * <LI>
82 * <CODE>object</CODE> is an instance of class OutputDeviceAssigned.
83 * <LI>
84 * This output device assigned attribute's underlying string and
85 * <CODE>object</CODE>'s underlying string are equal.
86 * <LI>
87 * This output device assigned attribute's locale and
88 * <CODE>object</CODE>'s locale are equal.
89 * </OL>
90 *
91 * @param object Object to compare to.
92 *
93 * @return True if <CODE>object</CODE> is equivalent to this output
94 * device assigned attribute, false otherwise.
95 */
96 public boolean equals(Object object) {
97 return (super.equals (object) &&
98 object instanceof OutputDeviceAssigned);
99 }
100
101 /**
102 * Get the printing attribute class which is to be used as the "category"
103 * for this printing attribute value.
104 * <P>
105 * For class OutputDeviceAssigned, the
106 * category is class OutputDeviceAssigned itself.
107 *
108 * @return Printing attribute class (category), an instance of class
109 * {@link java.lang.Class java.lang.Class}.
110 */
111 public final Class<? extends Attribute> getCategory() {
112 return OutputDeviceAssigned.class;
113 }
114
115 /**
116 * Get the name of the category of which this attribute value is an
117 * instance.
118 * <P>
119 * For class OutputDeviceAssigned, the
120 * category name is <CODE>"output-device-assigned"</CODE>.
121 *
122 * @return Attribute category name.
123 */
124 public final String getName() {
125 return "output-device-assigned";
126 }
127
128 }
Save This Page