libjava/classpath/javax/print/attribute/standard/CopiesSupported.java

   1 /* CopiesSupported.java --
   2    Copyright (C) 2004, 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.print.attribute.standard;
  39
  40 import javax.print.attribute.Attribute;
  41 import javax.print.attribute.SetOfIntegerSyntax;
  42 import javax.print.attribute.SupportedValuesAttribute;
  43
  44
  45 /**
  46  * The <code>CopiesSupported</code> attribute specifies the supported
  47  * value or range of values for the
  48  * {@link javax.print.attribute.standard.Copies} attribute.
  49  * <p>
  50  * <b>IPP Compatibility:</b> CopiesSupported is an IPP 1.1 attribute.
  51  * </p>
  52  *
  53  * @author Michael Koch (konqueror@gmx.de)
  54  * @author Wolfgang Baer (WBaer@gmx.de)
  55  */
  56 public final class CopiesSupported extends SetOfIntegerSyntax
  57   implements SupportedValuesAttribute
  58 {
  59   private static final long serialVersionUID = 6927711687034846001L;
  60
  61   /**
  62    * Constructs a <code>CopiesSupported</code> object with
  63    * the given value. This means that only this value is
  64    * supported for copies.
  65    *
  66    * @param member the member value
  67    * @exception IllegalArgumentException if member is &lt; 1
  68    */
  69   public CopiesSupported(int member)
  70   {
  71     super(member);
  72
  73     if (member < 1)
  74       throw new IllegalArgumentException("member may not be less than 1");
  75   }
  76
  77   /**
  78    * Constructs a <code>CopiesSupported</code> object with
  79    * the given range of values. This means that values for
  80    * copies are supported inside the specified range.
  81    *
  82    * @param lowerBound the lower bound value
  83    * @param upperBound the upper bound value
  84    *
  85    * @exception IllegalArgumentException if lowerBound &lt; 1
  86    */
  87   public CopiesSupported(int lowerBound, int upperBound)
  88   {
  89     super(lowerBound, upperBound);
  90
  91     if (lowerBound < 1)
  92       throw new IllegalArgumentException("lowerBound may not be less than 1");
  93   }
  94
  95   /**
  96    * Tests if the given object is equal to this object.
  97    *
  98    * @param obj the object to test
  99    *
 100    * @return <code>true</code> if both objects are equal,
 101    * <code>false</code> otherwise.
 102    */
 103   public boolean equals(Object obj)
 104   {
 105     if(! (obj instanceof CopiesSupported))
 106       return false;
 107
 108     return super.equals(obj);
 109   }
 110
 111   /**
 112    * Returns category of this class.
 113    *
 114    * @return The class <code>CopiesSupported</code> itself.
 115    */
 116   public Class< ? extends Attribute> getCategory()
 117   {
 118     return CopiesSupported.class;
 119   }
 120
 121   /**
 122    * Returns the name of this attribute.
 123    *
 124    * @return The name "copies-supported".
 125    */
 126   public String getName()
 127   {
 128     return "copies-supported";
 129   }
 130 }