001 /*
002 * Copyright 2000-2004 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025 package javax.print.attribute.standard;
026
027 import javax.print.attribute.Attribute;
028 import javax.print.attribute.IntegerSyntax;
029 import javax.print.attribute.PrintServiceAttribute;
030
031 /**
032 * Class PagesPerMinute is an integer valued printing attribute that indicates
033 * the nominal number of pages per minute to the nearest whole number which may
034 * be generated by this printer (e.g., simplex, black-and-white). This attribute
035 * is informative, not a service guarantee. Generally, it is the value used in
036 * the marketing literature to describe the device. A value of 0 indicates a
037 * device that takes more than two minutes to process a page.
038 * <P>
039 * <B>IPP Compatibility:</B> The integer value gives the IPP integer value. The
040 * category name returned by <CODE>getName()</CODE> gives the IPP attribute
041 * name.
042 * <P>
043 *
044 * @author Alan Kaminsky
045 */
046 public final class PagesPerMinute extends IntegerSyntax implements
047 PrintServiceAttribute {
048
049 private static final long serialVersionUID = -6366403993072862015L;
050
051 /**
052 * Construct a new pages per minute attribute with the given integer
053 * value.
054 *
055 * @param value Integer value.
056 *
057 * @exception IllegalArgumentException
058 * (Unchecked exception) Thrown if <CODE>value</CODE> is less than 0.
059 */
060 public PagesPerMinute(int value) {
061 super (value, 0, Integer.MAX_VALUE);
062 }
063
064 /**
065 * Returns whether this pages per minute attribute is equivalent to the
066 * passed in object. To be equivalent, all of the following conditions
067 * must be true:
068 * <OL TYPE=1>
069 * <LI>
070 * <CODE>object</CODE> is not null.
071 * <LI>
072 * <CODE>object</CODE> is an instance of class PagesPerMinute.
073 * <LI>
074 * This pages per minute attribute's value and <CODE>object</CODE>'s
075 * value are equal.
076 * </OL>
077 *
078 * @param object Object to compare to.
079 *
080 * @return True if <CODE>object</CODE> is equivalent to this pages per
081 * minute attribute, false otherwise.
082 */
083 public boolean equals(Object object) {
084 return (super .equals(object) && object instanceof PagesPerMinute);
085 }
086
087 /**
088 * Get the printing attribute class which is to be used as the "category"
089 * for this printing attribute value.
090 * <P>
091 * For class PagesPerMinute, the category is class PagesPerMinute itself.
092 *
093 * @return Printing attribute class (category), an instance of class
094 * {@link java.lang.Class java.lang.Class}.
095 */
096 public final Class<? extends Attribute> getCategory() {
097 return PagesPerMinute.class;
098 }
099
100 /**
101 * Get the name of the category of which this attribute value is an
102 * instance.
103 * <P>
104 * For class PagesPerMinute, the
105 * category name is <CODE>"pages-per-minute"</CODE>.
106 *
107 * @return Attribute category name.
108 */
109 public final String getName() {
110 return "pages-per-minute";
111 }
112
113 }
|