META-INF.modules.java.desktop.classes.javax.print.attribute.standard.PagesPerMinute Maven / Gradle / Ivy
Show all versions of java.desktop Show documentation
/*
* 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
* 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.IntegerSyntax;
import javax.print.attribute.PrintServiceAttribute;
/**
* Class {@code PagesPerMinute} is an integer valued printing attribute that
* indicates the nominal number of pages per minute to the nearest whole number
* which may be generated by this printer (e.g., simplex, black-and-white). This
* attribute is informative, not a service guarantee. Generally, it is the value
* used in the marketing literature to describe the device. A value of 0
* indicates a device that takes more than two minutes to process a page.
*
* IPP Compatibility: The integer value gives the IPP integer value. The
* category name returned by {@code getName()} gives the IPP attribute name.
*
* @author Alan Kaminsky
*/
public final class PagesPerMinute extends IntegerSyntax
implements PrintServiceAttribute {
/**
* Use serialVersionUID from JDK 1.4 for interoperability.
*/
private static final long serialVersionUID = -6366403993072862015L;
/**
* Construct a new pages per minute attribute with the given integer value.
*
* @param value Integer value
* @throws IllegalArgumentException if {@code value} is negative
*/
public PagesPerMinute(int value) {
super(value, 0, Integer.MAX_VALUE);
}
/**
* Returns whether this pages per minute attribute is equivalent to the
* passed in object. To be equivalent, all of the following conditions must
* be true:
*
* - {@code object} is not {@code null}.
*
- {@code object} is an instance of class {@code PagesPerMinute}.
*
- This pages per minute attribute's value and {@code object}'s value
* are equal.
*
*
* @param object {@code Object} to compare to
* @return {@code true} if {@code object} is equivalent to this pages per
* minute attribute, {@code false} otherwise
*/
public boolean equals(Object object) {
return (super.equals (object) &&
object instanceof PagesPerMinute);
}
/**
* Get the printing attribute class which is to be used as the "category"
* for this printing attribute value.
*
* For class {@code PagesPerMinute}, the category is class
* {@code PagesPerMinute} itself.
*
* @return printing attribute class (category), an instance of class
* {@link Class java.lang.Class}
*/
public final Class getCategory() {
return PagesPerMinute.class;
}
/**
* Get the name of the category of which this attribute value is an
* instance.
*
* For class {@code PagesPerMinute}, the category name is
* {@code "pages-per-minute"}.
*
* @return attribute category name
*/
public final String getName() {
return "pages-per-minute";
}
}