1 /*
   2  * Copyright (c) 2000, 2017, 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 
  26 package javax.print.attribute.standard;
  27 
  28 import javax.print.attribute.Attribute;
  29 import javax.print.attribute.IntegerSyntax;
  30 import javax.print.attribute.PrintServiceAttribute;
  31 
  32 /**
  33  * Class {@code PagesPerMinute} is an integer valued printing attribute that
  34  * indicates the nominal number of pages per minute to the nearest whole number
  35  * which may be generated by this printer (e.g., simplex, black-and-white). This
  36  * attribute is informative, not a service guarantee. Generally, it is the value
  37  * used in the marketing literature to describe the device. A value of 0
  38  * indicates a device that takes more than two minutes to process a page.
  39  * <p>
  40  * <b>IPP Compatibility:</b> The integer value gives the IPP integer value. The
  41  * category name returned by {@code getName()} gives the IPP attribute name.
  42  *
  43  * @author Alan Kaminsky
  44  */
  45 public final class PagesPerMinute extends IntegerSyntax
  46         implements PrintServiceAttribute {
  47 
  48     /**
  49      * Use serialVersionUID from JDK 1.4 for interoperability.
  50      */
  51     private static final long serialVersionUID = -6366403993072862015L;
  52 
  53     /**
  54      * Construct a new pages per minute attribute with the given integer value.
  55      *
  56      * @param  value Integer value
  57      * @throws IllegalArgumentException if {@code value} is negative
  58      */
  59     public PagesPerMinute(int value) {
  60         super(value, 0, Integer.MAX_VALUE);
  61     }
  62 
  63     /**
  64      * Returns whether this pages per minute attribute is equivalent to the
  65      * passed in object. To be equivalent, all of the following conditions must
  66      * be true:
  67      * <ol type=1>
  68      *   <li>{@code object} is not {@code null}.
  69      *   <li>{@code object} is an instance of class {@code PagesPerMinute}.
  70      *   <li>This pages per minute attribute's value and {@code object}'s value
  71      *   are equal.
  72      * </ol>
  73      *
  74      * @param  object {@code Object} to compare to
  75      * @return {@code true} if {@code object} is equivalent to this pages per
  76      *         minute attribute, {@code false} otherwise
  77      */
  78     public boolean equals(Object object) {
  79         return (super.equals (object) &&
  80                 object instanceof PagesPerMinute);
  81     }
  82 
  83     /**
  84      * Get the printing attribute class which is to be used as the "category"
  85      * for this printing attribute value.
  86      * <p>
  87      * For class {@code PagesPerMinute}, the category is class
  88      * {@code PagesPerMinute} itself.
  89      *
  90      * @return printing attribute class (category), an instance of class
  91      *         {@link Class java.lang.Class}
  92      */
  93     public final Class<? extends Attribute> getCategory() {
  94         return PagesPerMinute.class;
  95     }
  96 
  97     /**
  98      * Get the name of the category of which this attribute value is an
  99      * instance.
 100      * <p>
 101      * For class {@code PagesPerMinute}, the category name is
 102      * {@code "pages-per-minute"}.
 103      *
 104      * @return attribute category name
 105      */
 106     public final String getName() {
 107         return "pages-per-minute";
 108     }
 109 }