1 /*
2 * Copyright (c) 2000, 2014, 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 package javax.print.attribute.standard;
26
27 import javax.print.attribute.Attribute;
28 import javax.print.attribute.ResolutionSyntax;
29 import javax.print.attribute.DocAttribute;
30 import javax.print.attribute.PrintRequestAttribute;
31 import javax.print.attribute.PrintJobAttribute;
32
33 /**
34 * Class PrinterResolution is a printing attribute class that specifies an
35 * exact resolution supported by a printer or to be used for a print job.
36 * This attribute assumes that printers have a small set of device resolutions
37 * at which they can operate rather than a continuum.
38 * <p>
39 * PrinterResolution is used in multiple ways:
40 * <OL TYPE=1>
41 * <LI>
42 * When a client searches looking for a printer that supports the client's
43 * desired resolution exactly (no more, no less), the client specifies
44 * an instance of class PrinterResolution indicating the exact resolution the
45 * client wants. Only printers supporting that exact resolution will match the
46 * search.
47 *
48 * <LI>
49 * When a client needs to print a job using the client's desired resolution
50 * exactly (no more, no less), the client specifies an instance of class
51 * PrinterResolution as an attribute of the Print Job. This will fail if the
52 * Print Job doesn't support that exact resolution, and Fidelity is set to
53 * true.
54 * </OL>
55 * If a client wants to locate a printer supporting a resolution
56 * greater than some required minimum, then it may be necessary to exclude
57 * this attribute from a lookup request and to directly query the set of
58 * supported resolutions, and specify the one that most closely meets
59 * the client's requirements.
60 * In some cases this may be more simply achieved by specifying a
61 * PrintQuality attribute which often controls resolution.
62 * <P>
63 * <B>IPP Compatibility:</B> The information needed to construct an IPP
64 * <CODE>"printer-resolution"</CODE> attribute can be obtained by calling
65 * methods on the PrinterResolution object. The category name returned by
66 * <CODE>getName()</CODE> gives the IPP attribute name.
67 *
68 * @author David Mendenhall
69 * @author Alan Kaminsky
70 */
71 public final class PrinterResolution extends ResolutionSyntax
72 implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {
73
74 private static final long serialVersionUID = 13090306561090558L;
75
76 /**
77 * Construct a new printer resolution attribute from the given items.
78 *
79 * @param crossFeedResolution
80 * Cross feed direction resolution.
81 * @param feedResolution
82 * Feed direction resolution.
83 * @param units
84 * Unit conversion factor, e.g. <code>ResolutionSyntax.DPI</CODE>
85 * or <code>ResolutionSyntax.DPCM</CODE>.
86 *
87 * @exception IllegalArgumentException
88 * (unchecked exception) Thrown if {@code crossFeedResolution < 1} or
89 * {@code feedResolution < 1} or {@code units < 1}.
90 */
91 public PrinterResolution(int crossFeedResolution, int feedResolution,
92 int units) {
93 super (crossFeedResolution, feedResolution, units);
94 }
95
96 /**
97 * Returns whether this printer resolution attribute is equivalent to the
98 * passed in object. To be equivalent, all of the following conditions
99 * must be true:
100 * <OL TYPE=1>
101 * <LI>
102 * <CODE>object</CODE> is not null.
103 * <LI>
104 * <CODE>object</CODE> is an instance of class PrinterResolution.
105 * <LI>
106 * This attribute's cross feed direction resolution is equal to
107 * <CODE>object</CODE>'s cross feed direction resolution.
108 * <LI>
109 * This attribute's feed direction resolution is equal to
110 * <CODE>object</CODE>'s feed direction resolution.
111 * </OL>
112 *
113 * @param object Object to compare to.
114 *
115 * @return True if <CODE>object</CODE> is equivalent to this printer
116 * resolution attribute, false otherwise.
117 */
118 public boolean equals(Object object) {
119 return (super.equals (object) &&
120 object instanceof PrinterResolution);
121 }
122
123 /**
124 * Get the printing attribute class which is to be used as the "category"
125 * for this printing attribute value.
126 * <P>
127 * For class PrinterResolution, the category is class PrinterResolution itself.
128 *
129 * @return Printing attribute class (category), an instance of class
130 * {@link java.lang.Class java.lang.Class}.
131 */
132 public final Class<? extends Attribute> getCategory() {
133 return PrinterResolution.class;
134 }
135
136 /**
137 * Get the name of the category of which this attribute value is an
138 * instance.
139 * <P>
140 * For class PrinterResolution, the
141 * category name is <CODE>"printer-resolution"</CODE>.
142 *
143 * @return Attribute category name.
144 */
145 public final String getName() {
146 return "printer-resolution";
147 }
148
149 }