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