Source for javax.print.attribute.standard.NumberUpSupported

   1: /* NumberUpSupported.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>NumberUpSupported</code> printing attribute specifies the
  47:  * supported value or range of values for the
  48:  * {@link javax.print.attribute.standard.NumberUp} attribute.
  49:  * <p>
  50:  * <b>IPP Compatibility:</b> NumberUpSupported 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 NumberUpSupported extends SetOfIntegerSyntax
  57:   implements SupportedValuesAttribute
  58: {
  59:   private static final long serialVersionUID = -1041573395759141805L;
  60: 
  61:   /**
  62:    * Constructs a <code>NumberUpSupported</code> object.
  63:    *
  64:    * @param member the only one value supported for number up.
  65:    *
  66:    * @exception IllegalArgumentException if member is &lt; 1
  67:    */
  68:   public NumberUpSupported(int member)
  69:   {
  70:     super(member);
  71: 
  72:     if (member < 1)
  73:       throw new IllegalArgumentException("member may not be less than 1");
  74:   }
  75: 
  76:   /**
  77:    * Constructs a <code>NumberUpSupported</code> object.
  78:    *
  79:    * @param members the members supported for number up.
  80:    *
  81:    * @exception IllegalArgumentException if any element is invalid
  82:    * @exception NullPointerException if members is <code>null</code> or any
  83:    * element of members is <code>null</code>.
  84:    */
  85:   public NumberUpSupported(int[][] members)
  86:   {
  87:     super(members);
  88: 
  89:     if (members == null)
  90:       throw new NullPointerException("members may not be null");
  91:   }
  92: 
  93:   /**
  94:    * Constructs a <code>NumberUpSupported</code> object with the
  95:    * given range for supported number up values.
  96:    *
  97:    * @param lowerBound the lower bound value
  98:    * @param upperBound the upper bound value
  99:    *
 100:    * @exception IllegalArgumentException if lowerBound &lt;= upperbound
 101:    * and lowerBound &lt; 1
 102:    */
 103:   public NumberUpSupported(int lowerBound, int upperBound)
 104:   {
 105:     super(lowerBound, upperBound);
 106: 
 107:     if (lowerBound < 1)
 108:       throw new IllegalArgumentException("lowerBound may not be less than 1");
 109:   }
 110: 
 111:   /**
 112:    * Tests if the given object is equal to this object.
 113:    *
 114:    * @param obj the object to test
 115:    *
 116:    * @return <code>true</code> if both objects are equal,
 117:    * <code>false</code> otherwise.
 118:    */
 119:   public boolean equals(Object obj)
 120:   {
 121:     if (! (obj instanceof NumberUpSupported))
 122:       return false;
 123: 
 124:     return super.equals(obj);
 125:   }
 126: 
 127:   /**
 128:    * Returns category of this class.
 129:    *
 130:    * @return The class <code>NumberUpSupported</code> itself.
 131:    */
 132:   public Class< ? extends Attribute> getCategory()
 133:   {
 134:     return NumberUpSupported.class;
 135:   }
 136: 
 137:   /**
 138:    * Returns the name of this attribute.
 139:    *
 140:    * @return The name "number-up-supported".
 141:    */
 142:   public String getName()
 143:   {
 144:     return "number-up-supported";
 145:   }
 146: }