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.net.URI;
28
29 import javax.print.attribute.Attribute;
30 import javax.print.attribute.URISyntax;
31 import javax.print.attribute.PrintServiceAttribute;
32
33 /**
34 * Class PrinterMoreInfo is a printing attribute class, a URI, that is used to
35 * obtain more information about this specific printer. For example, this
36 * could be an HTTP type URI referencing an HTML page accessible to a web
37 * browser. The information obtained from this URI is intended for end user
38 * consumption. Features outside the scope of the Print Service API can be
39 * accessed from this URI.
40 * The information is intended to be specific to this printer instance and
41 * site specific services (e.g. job pricing, services offered, end user
42 * assistance).
43 * <P>
44 * In contrast, the {@link PrinterMoreInfoManufacturer
45 * PrinterMoreInfoManufacturer} attribute is used to find out more information
46 * about this general kind of printer rather than this specific printer.
47 * <P>
48 * <B>IPP Compatibility:</B> The string form returned by
49 * <CODE>toString()</CODE> gives the IPP uri value.
50 * The category name returned by <CODE>getName()</CODE>
51 * gives the IPP attribute name.
52 * <P>
53 *
54 * @author Alan Kaminsky
55 */
56 public final class PrinterMoreInfo extends URISyntax
57 implements PrintServiceAttribute {
58
59 private static final long serialVersionUID = 4555850007675338574L;
60
61 /**
62 * Constructs a new printer more info attribute with the specified URI.
63 *
64 * @param uri URI.
65 *
66 * @exception NullPointerException
67 * (unchecked exception) Thrown if <CODE>uri</CODE> is null.
68 */
69 public PrinterMoreInfo(URI uri) {
70 super (uri);
71 }
72
73 /**
74 * Returns whether this printer more info attribute is equivalent to the
75 * passed in object. To be equivalent, all of the following conditions
76 * must be true:
77 * <OL TYPE=1>
78 * <LI>
79 * <CODE>object</CODE> is not null.
80 * <LI>
81 * <CODE>object</CODE> is an instance of class PrinterMoreInfo.
82 * <LI>
83 * This printer more info attribute's URI and <CODE>object</CODE>'s URI
84 * 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 * more info attribute, false otherwise.
91 */
92 public boolean equals(Object object) {
93 return (super.equals(object) &&
94 object instanceof PrinterMoreInfo);
95 }
96
97 /**
98 * Get the printing attribute class which is to be used as the "category"
99 * for this printing attribute value.
100 * <P>
101 * For class PrinterMoreInfo, the category is class PrinterMoreInfo itself.
102 *
103 * @return Printing attribute class (category), an instance of class
104 * {@link java.lang.Class java.lang.Class}.
105 */
106 public final Class<? extends Attribute> getCategory() {
107 return PrinterMoreInfo.class;
108 }
109
110 /**
111 * Get the name of the category of which this attribute value is an
112 * instance.
113 * <P>
114 * For class PrinterMoreInfo, the
115 * category name is <CODE>"printer-more-info"</CODE>.
116 *
117 * @return Attribute category name.
118 */
119 public final String getName() {
120 return "printer-more-info";
121 }
122
123 }
Save This Page