Source for javax.print.attribute.EnumSyntax

   1: /* EnumSyntax.java -- 
   2:    Copyright (C) 2003 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:  * @author Michael Koch
  44:  */
  45: public abstract class EnumSyntax implements Cloneable, Serializable
  46: {
  47:   private static final long serialVersionUID = -2739521845085831642L;
  48:   
  49:   private int value;
  50: 
  51:   /**
  52:    * Creates a <code>EnumSyntax</code> object.
  53:    *
  54:    * @param value the value to set
  55:    */
  56:   protected EnumSyntax(int value)
  57:   {
  58:     this.value = value;
  59:   }
  60: 
  61:   /**
  62:    * Returns the value of this object.
  63:    *
  64:    * @return the value
  65:    */
  66:   public int getValue()
  67:   {
  68:     return value;
  69:   }
  70: 
  71:   /**
  72:    * Clones this object.
  73:    *
  74:    * @return a clone of this object
  75:    */
  76:   public Object clone()
  77:   {
  78:     try
  79:       {
  80:         return super.clone();
  81:       }
  82:     catch (CloneNotSupportedException e)
  83:       {
  84:         // Cannot happen as we implement java.lang.Cloneable.
  85:         return null;
  86:       }
  87:   }
  88: 
  89:   /**
  90:    * Returns the hashcode for this object.
  91:    *
  92:    * @return the hashcode
  93:    */
  94:   public int hashCode()
  95:   {
  96:     return value;
  97:   }
  98: 
  99:   /**
 100:    * Returns the string representation for this object.
 101:    *
 102:    * @return the string representation
 103:    */
 104:   public String toString()
 105:   {
 106:     int index = value - getOffset();
 107:     String[] table = getStringTable();
 108: 
 109:     if (table != null
 110:         && index >= 0
 111:         && index < table.length)
 112:       return table[index];
 113:     
 114:     return "" + value;
 115:   }
 116: 
 117:   /**
 118:    * Returns a table with the enumeration values represented as strings
 119:    * for this object.
 120:    *
 121:    * The default implementation just returns null.
 122:    *
 123:    * @return the enumeration values as strings
 124:    */
 125:   protected String[] getStringTable()
 126:   {
 127:     return null;
 128:   }
 129: 
 130:   /**
 131:    * Returns a table with the enumeration values for this object.
 132:    *
 133:    * The default implementation just returns null.
 134:    *
 135:    * @return the enumeration values
 136:    */
 137:   protected EnumSyntax[] getEnumValueTable()
 138:   {
 139:     return null;
 140:   }
 141: 
 142:   protected int getOffset()
 143:   {
 144:     return 0;
 145:   }
 146: }