Source for javax.print.attribute.IntegerSyntax

   1: /* IntegerSyntax.java -- 
   2:    Copyright (C) 2003, 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;
  39: 
  40: import java.io.Serializable;
  41: 
  42: /**
  43:  * <code>IntegerSyntax</code> is the abstract base class of all attribute 
  44:  * classes having an integer as value.
  45:  * 
  46:  * @author Michael Koch (konqueror@gmx.de)
  47:  */
  48: public abstract class IntegerSyntax implements Cloneable, Serializable
  49: {
  50:   private int value;
  51: 
  52:   /**
  53:    * Creates a <code>IntegerSyntax</code> with the given value.
  54:    *
  55:    * @param value the integer to set
  56:    */
  57:   protected IntegerSyntax(int value)
  58:   {
  59:     this.value = value;
  60:   }
  61: 
  62:   /**
  63:    * Creates a <code>IntegerSyntax</code> with the given integer value
  64:    * and checks if the value lies inside the given bounds..
  65:    *
  66:    * @param value the integer to set
  67:    * @param lowerBound the lower bound for the value
  68:    * @param upperBound the upper bound for the value
  69:    *
  70:    * @exception IllegalArgumentException if value < lowerBound
  71:    * or value > upperBound
  72:    */
  73:   protected IntegerSyntax(int value, int lowerBound, int upperBound)
  74:   {
  75:     if (value < lowerBound
  76:         || value > upperBound)
  77:       throw new IllegalArgumentException("value not in range");
  78: 
  79:     this.value = value;
  80:   }
  81: 
  82:   /**
  83:    * Returns the value of this object.
  84:    *
  85:    * @return The integer value.
  86:    */
  87:   public int getValue()
  88:   {
  89:     return value;
  90:   }
  91: 
  92:   /**
  93:    * Tests if the given object is equal to this object.
  94:    *
  95:    * @param obj the object to test
  96:    *
  97:    * @return <code>true</code> if both objects are equal, 
  98:    * <code>false</code> otherwise.
  99:    */
 100:   public boolean equals(Object obj)
 101:   {
 102:     if(! (obj instanceof IntegerSyntax))
 103:       return false;
 104: 
 105:     return value == ((IntegerSyntax) obj).getValue();
 106:   }
 107: 
 108:   /**
 109:    * Returns the hashcode for this object.
 110:    *
 111:    * @return The hashcode.
 112:    */
 113:   public int hashCode()
 114:   {
 115:     return value;
 116:   }
 117: 
 118:   /**
 119:    * Returns the string representation for this object.
 120:    *
 121:    * @return The string representation.
 122:    */
 123:   public String toString()
 124:   {
 125:     return "" + value;
 126:   }
 127: }