< prev index next >
src/java.desktop/share/classes/javax/print/attribute/standard/PrinterResolution.java
Print this page
@@ -1,7 +1,7 @@
/*
- * Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
@@ -20,130 +20,120 @@
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
+
package javax.print.attribute.standard;
import javax.print.attribute.Attribute;
-import javax.print.attribute.ResolutionSyntax;
import javax.print.attribute.DocAttribute;
-import javax.print.attribute.PrintRequestAttribute;
import javax.print.attribute.PrintJobAttribute;
+import javax.print.attribute.PrintRequestAttribute;
+import javax.print.attribute.ResolutionSyntax;
/**
- * Class PrinterResolution is a printing attribute class that specifies an
- * exact resolution supported by a printer or to be used for a print job.
+ * Class {@code PrinterResolution} is a printing attribute class that specifies
+ * an exact resolution supported by a printer or to be used for a print job.
* This attribute assumes that printers have a small set of device resolutions
* at which they can operate rather than a continuum.
* <p>
- * PrinterResolution is used in multiple ways:
- * <OL TYPE=1>
- * <LI>
- * When a client searches looking for a printer that supports the client's
- * desired resolution exactly (no more, no less), the client specifies
- * an instance of class PrinterResolution indicating the exact resolution the
- * client wants. Only printers supporting that exact resolution will match the
- * search.
- *
- * <LI>
- * When a client needs to print a job using the client's desired resolution
- * exactly (no more, no less), the client specifies an instance of class
- * PrinterResolution as an attribute of the Print Job. This will fail if the
- * Print Job doesn't support that exact resolution, and Fidelity is set to
- * true.
- * </OL>
- * If a client wants to locate a printer supporting a resolution
- * greater than some required minimum, then it may be necessary to exclude
- * this attribute from a lookup request and to directly query the set of
- * supported resolutions, and specify the one that most closely meets
- * the client's requirements.
- * In some cases this may be more simply achieved by specifying a
- * PrintQuality attribute which often controls resolution.
- * <P>
- * <B>IPP Compatibility:</B> The information needed to construct an IPP
- * {@code "printer-resolution"} attribute can be obtained by calling
- * methods on the PrinterResolution object. The category name returned by
- * {@code getName()} gives the IPP attribute name.
+ * {@code PrinterResolution} is used in multiple ways:
+ * <ol type=1>
+ * <li>When a client searches looking for a printer that supports the client's
+ * desired resolution exactly (no more, no less), the client specifies an
+ * instance of class {@code PrinterResolution} indicating the exact resolution
+ * the client wants. Only printers supporting that exact resolution will match
+ * the search.
+ * <li>When a client needs to print a job using the client's desired
+ * resolution exactly (no more, no less), the client specifies an instance of
+ * class {@code PrinterResolution} as an attribute of the Print Job. This will
+ * fail if the Print Job doesn't support that exact resolution, and
+ * {@code Fidelity} is set to true.
+ * </ol>
+ * If a client wants to locate a printer supporting a resolution greater than
+ * some required minimum, then it may be necessary to exclude this attribute
+ * from a lookup request and to directly query the set of supported resolutions,
+ * and specify the one that most closely meets the client's requirements. In
+ * some cases this may be more simply achieved by specifying a
+ * {@code PrintQuality} attribute which often controls resolution.
+ * <p>
+ * <b>IPP Compatibility:</b> The information needed to construct an IPP
+ * {@code "printer-resolution"} attribute can be obtained by calling methods on
+ * the PrinterResolution object. The category name returned by {@code getName()}
+ * gives the IPP attribute name.
*
* @author David Mendenhall
* @author Alan Kaminsky
*/
public final class PrinterResolution extends ResolutionSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {
+ /**
+ * Use serialVersionUID from JDK 1.4 for interoperability.
+ */
private static final long serialVersionUID = 13090306561090558L;
/**
* Construct a new printer resolution attribute from the given items.
*
- * @param crossFeedResolution
- * Cross feed direction resolution.
- * @param feedResolution
- * Feed direction resolution.
- * @param units
- * Unit conversion factor, e.g. {@code ResolutionSyntax.DPI}
- * or {@code ResolutionSyntax.DPCM}.
- *
- * @exception IllegalArgumentException
- * (unchecked exception) Thrown if {@code crossFeedResolution < 1} or
- * {@code feedResolution < 1} or {@code units < 1}.
+ * @param crossFeedResolution cross feed direction resolution
+ * @param feedResolution feed direction resolution
+ * @param units unit conversion factor, e.g. {@code ResolutionSyntax.DPI}
+ * or {@code ResolutionSyntax.DPCM}
+ * @throws IllegalArgumentException if {@code crossFeedResolution < 1} or
+ * {@code feedResolution < 1} or {@code units < 1}
*/
public PrinterResolution(int crossFeedResolution, int feedResolution,
int units) {
super (crossFeedResolution, feedResolution, units);
}
/**
* Returns whether this printer resolution attribute is equivalent to the
- * passed in object. To be equivalent, all of the following conditions
- * must be true:
- * <OL TYPE=1>
- * <LI>
- * {@code object} is not null.
- * <LI>
- * {@code object} is an instance of class PrinterResolution.
- * <LI>
- * This attribute's cross feed direction resolution is equal to
+ * passed in object. To be equivalent, all of the following conditions must
+ * be true:
+ * <ol type=1>
+ * <li>{@code object} is not {@code null}.
+ * <li>{@code object} is an instance of class {@code PrinterResolution}.
+ * <li>This attribute's cross feed direction resolution is equal to
* {@code object}'s cross feed direction resolution.
- * <LI>
- * This attribute's feed direction resolution is equal to
+ * <li>This attribute's feed direction resolution is equal to
* {@code object}'s feed direction resolution.
- * </OL>
- *
- * @param object Object to compare to.
+ * </ol>
*
- * @return True if {@code object} is equivalent to this printer
- * resolution attribute, false otherwise.
+ * @param object {@code Object} to compare to
+ * @return {@code true} if {@code object} is equivalent to this printer
+ * resolution attribute, {@code false} otherwise
*/
public boolean equals(Object object) {
return (super.equals (object) &&
object instanceof PrinterResolution);
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
- * <P>
- * For class PrinterResolution, the category is class PrinterResolution itself.
+ * <p>
+ * For class {@code PrinterResolution}, the category is class
+ * {@code PrinterResolution} itself.
*
- * @return Printing attribute class (category), an instance of class
- * {@link java.lang.Class java.lang.Class}.
+ * @return printing attribute class (category), an instance of class
+ * {@link Class java.lang.Class}
*/
public final Class<? extends Attribute> getCategory() {
return PrinterResolution.class;
}
/**
* Get the name of the category of which this attribute value is an
* instance.
- * <P>
- * For class PrinterResolution, the
- * category name is {@code "printer-resolution"}.
+ * <p>
+ * For class {@code PrinterResolution}, the category name is
+ * {@code "printer-resolution"}.
*
- * @return Attribute category name.
+ * @return attribute category name
*/
public final String getName() {
return "printer-resolution";
}
-
}
< prev index next >