1 /*
2 * Copyright (c) 2000, 2017, Oracle and/or its affiliates. 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. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.print.attribute.standard;
27
28 import java.net.URI;
29
30 import javax.print.attribute.Attribute;
31 import javax.print.attribute.PrintServiceAttribute;
32 import javax.print.attribute.URISyntax;
33
34 /**
35 * Class {@code PrinterMoreInfoManufacturer} is a printing attribute class, a
36 * {@code URI}, that is used to obtain more information about this type of
37 * device. The information obtained from this {@code URI} is intended for end
38 * user consumption. Features outside the scope of the Print Service API can be
39 * accessed from this {@code URI} (e.g., latest firmware, upgrades, service
40 * proxies, optional features available, details on color support). The
41 * information is intended to be germane to this kind of printer without regard
42 * to site specific modifications or services.
43 * <p>
44 * In contrast, the {@link PrinterMoreInfo PrinterMoreInfo} attribute is used to
45 * find out more information about this specific printer rather than this
46 * general kind of printer.
47 * <p>
48 * <b>IPP Compatibility:</b> The string form returned by {@code toString()}
49 * gives the IPP uri value. The category name returned by {@code getName()}
50 * gives the IPP attribute name.
51 *
52 * @author Alan Kaminsky
53 */
54 public final class PrinterMoreInfoManufacturer extends URISyntax
55 implements PrintServiceAttribute {
56
57 /**
58 * Use serialVersionUID from JDK 1.4 for interoperability.
59 */
60 private static final long serialVersionUID = 3323271346485076608L;
61
62 /**
63 * Constructs a new printer more info manufacturer attribute with the
64 * specified {@code URI}.
65 *
66 * @param uri {@code URI}
67 * @throws NullPointerException if {@code uri} is {@code null}
68 */
69 public PrinterMoreInfoManufacturer(URI uri) {
70 super (uri);
71 }
72
73 /**
74 * Returns whether this printer more info manufacturer attribute is
75 * equivalent to the passed in object. To be equivalent, all of the
76 * following conditions must be true:
77 * <ol type=1>
78 * <li>{@code object} is not {@code null}.
79 * <li>{@code object} is an instance of class
80 * {@code PrinterMoreInfoManufacturer}.
81 * <li>This printer more info manufacturer attribute's {@code URI} and
82 * {@code object}'s {@code URI} are equal.
83 * </ol>
84 *
85 * @param object {@code Object} to compare to
86 * @return {@code true} if {@code object} is equivalent to this printer more
87 * info manufacturer attribute, {@code false} otherwise
88 */
89 public boolean equals(Object object) {
90 return (super.equals(object) &&
91 object instanceof PrinterMoreInfoManufacturer);
92 }
93
94 /**
95 * Get the printing attribute class which is to be used as the "category"
96 * for this printing attribute value.
97 * <p>
98 * For class {@code PrinterMoreInfoManufacturer}, the category is class
99 * {@code PrinterMoreInfoManufacturer} itself.
100 *
101 * @return printing attribute class (category), an instance of class
102 * {@link Class java.lang.Class}
103 */
104 public final Class<? extends Attribute> getCategory() {
105 return PrinterMoreInfoManufacturer.class;
106 }
107
108 /**
109 * Get the name of the category of which this attribute value is an
110 * instance.
111 * <p>
112 * For class {@code PrinterMoreInfoManufacturer}, the category name is
113 * {@code "printer-more-info-manufacturer"}.
114 *
115 * @return attribute category name
116 */
117 public final String getName() {
118 return "printer-more-info-manufacturer";
119 }
120 }