1 /*
2 * Copyright (c) 2000, 2013, 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 * <P>
68 *
69 * @author David Mendenhall
70 * @author Alan Kaminsky
71 */
72 public final class PrinterResolution extends ResolutionSyntax
73 implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {
74
75 private static final long serialVersionUID = 13090306561090558L;
76
77 /**
78 * Construct a new printer resolution attribute from the given items.
79 *
80 * @param crossFeedResolution
81 * Cross feed direction resolution.
82 * @param feedResolution
83 * Feed direction resolution.
84 * @param units
85 * Unit conversion factor, e.g. <code>ResolutionSyntax.DPI</CODE>
86 * or <code>ResolutionSyntax.DPCM</CODE>.
87 *
88 * @exception IllegalArgumentException
89 * (unchecked exception) Thrown if {@code crossFeedResolution < 1} or
90 * {@code feedResolution < 1} or {@code units < 1}.
91 */
92 public PrinterResolution(int crossFeedResolution, int feedResolution,
93 int units) {
94 super (crossFeedResolution, feedResolution, units);
95 }
96
97 /**
98 * Returns whether this printer resolution attribute is equivalent to the
99 * passed in object. To be equivalent, all of the following conditions
100 * must be true:
101 * <OL TYPE=1>
102 * <LI>
103 * <CODE>object</CODE> is not null.
104 * <LI>
105 * <CODE>object</CODE> is an instance of class PrinterResolution.
106 * <LI>
107 * This attribute's cross feed direction resolution is equal to
108 * <CODE>object</CODE>'s cross feed direction resolution.
109 * <LI>
110 * This attribute's feed direction resolution is equal to
111 * <CODE>object</CODE>'s feed direction resolution.
112 * </OL>
113 *
114 * @param object Object to compare to.
115 *
116 * @return True if <CODE>object</CODE> is equivalent to this printer
117 * resolution attribute, false otherwise.
118 */
119 public boolean equals(Object object) {
120 return (super.equals (object) &&
121 object instanceof PrinterResolution);
122 }
123
124 /**
125 * Get the printing attribute class which is to be used as the "category"
126 * for this printing attribute value.
127 * <P>
128 * For class PrinterResolution, the category is class PrinterResolution itself.
129 *
130 * @return Printing attribute class (category), an instance of class
131 * {@link java.lang.Class java.lang.Class}.
132 */
133 public final Class<? extends Attribute> getCategory() {
134 return PrinterResolution.class;
135 }
136
137 /**
138 * Get the name of the category of which this attribute value is an
139 * instance.
140 * <P>
141 * For class PrinterResolution, the
142 * category name is <CODE>"printer-resolution"</CODE>.
143 *
144 * @return Attribute category name.
145 */
146 public final String getName() {
147 return "printer-resolution";
148 }
149
150 }