Source for gnu.javax.swing.text.html.parser.support.gnuStringIntMapper

   1: /* gnuStringIntMapper.java --
   2:    Copyright (C) 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: 
  39: package gnu.javax.swing.text.html.parser.support;
  40: 
  41: import java.util.HashMap;
  42: import java.util.Map;
  43: import java.util.TreeMap;
  44: 
  45: /**
  46:  * A helper class, mapping between the strings and they unique integer
  47:  * identifiers.
  48:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  49:  */
  50: public abstract class gnuStringIntMapper
  51: {
  52:   /**
  53:    * Maps argument integer values from DTDConstants into they string
  54:    * names. Initialized on demand.
  55:    */
  56:   private Map is_Map;
  57: 
  58:   /**
  59:    * Maps argument string names into they integer values from DTDConstants.
  60:    * Initialized on demand.
  61:    */
  62:   private Map si_Map;
  63: 
  64:   /**
  65:    *  Get string from id or null if no such id is present in the mapper.
  66:    */
  67:   public final String get(int id)
  68:   {
  69:     if (is_Map == null)
  70:       createTheMap();
  71: 
  72:     return (String) is_Map.get(new Integer(id));
  73:   }
  74: 
  75:   /** Get id from string or 0 if no such string is present in the mapper. */
  76:   public final int get(String id)
  77:   {
  78:     if (si_Map == null)
  79:       createTheMap();
  80: 
  81:     Integer i = (Integer) si_Map.get(id);
  82: 
  83:     return i != null ? i.intValue() : 0;
  84:   }
  85: 
  86:   /**
  87:    * Create the mapping table for this mapper by adding the required
  88:    * String/int pairs. The method is invoked
  89:    * only once for each instance, after the first invocation of the any
  90:    * form of the <code>get</code> method. Use <code>add</code> to
  91:    * create a map for a concrete instance.
  92:    */
  93:   protected abstract void create();
  94: 
  95:   /**
  96:    * Add an id/string pair to this mapper. This is called from
  97:    * the method <code>create</code> only.
  98:    */
  99:   protected void add(String name, int id)
 100:   {
 101:     Integer i = new Integer(id);
 102:     si_Map.put(name, i);
 103:     is_Map.put(i, name);
 104:   }
 105: 
 106:   private void createTheMap()
 107:   {
 108:     is_Map = new HashMap();
 109:     si_Map = new TreeMap();
 110:     create();
 111:   }
 112: }