/* * Copyright (c) 2000, 2014, 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 * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * 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; /** * Class 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. *
* PrinterResolution is used in multiple ways: *
* IPP Compatibility: The information needed to construct an IPP
* "printer-resolution"
attribute can be obtained by calling
* methods on the PrinterResolution object. The category name returned by
* getName()
gives the IPP attribute name.
*
* @author David Mendenhall
* @author Alan Kaminsky
*/
public final class PrinterResolution extends ResolutionSyntax
implements DocAttribute, PrintRequestAttribute, PrintJobAttribute {
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. ResolutionSyntax.DPI
* or ResolutionSyntax.DPCM
.
*
* @exception IllegalArgumentException
* (unchecked exception) Thrown 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:
*
object
is not null.
* object
is an instance of class PrinterResolution.
* object
's cross feed direction resolution.
* object
's feed direction resolution.
* object
is equivalent to this printer
* resolution attribute, 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.
* * For class PrinterResolution, the category is class PrinterResolution itself. * * @return Printing attribute class (category), an instance of class * {@link java.lang.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. *
* For class PrinterResolution, the
* category name is "printer-resolution"
.
*
* @return Attribute category name.
*/
public final String getName() {
return "printer-resolution";
}
}