source/mir/util/StringRoutines.java

   1 /*
   2  * Copyright (C) 2001, 2002  The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir 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 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package mir.util;
  33
  34 import gnu.regexp.RE;
  35 import gnu.regexp.REException;
  36
  37 import java.util.List;
  38 import java.util.Vector;
  39
  40 public class StringRoutines {
  41
  42   private StringRoutines() {
  43   }
  44
  45   static int indexOfCharacters(String aString, char[] aCharacters, int aFrom) {
  46     int i;
  47     int result=-1;
  48     int position;
  49
  50     for (i=0; i<aCharacters.length ; i++) {
  51       position = aString.indexOf(aCharacters[i], aFrom);
  52
  53       if (position != -1 && ( result == -1 || position < result )) {
  54         result = position;
  55       }
  56     }
  57
  58     return result;
  59   }
  60
  61   static String replaceStringCharacters(String aText, char[] aCharactersToReplace, String[] aStringsToSubstitute) {
  62     if (aText==null)
  63       return null;
  64
  65     int position, nextPosition;
  66     int i;
  67     StringBuffer result = new StringBuffer();
  68
  69     position=0;
  70     do {
  71       nextPosition = StringRoutines.indexOfCharacters(aText, aCharactersToReplace, position);
  72
  73       if (nextPosition<0)
  74         nextPosition = aText.length();
  75
  76       result.append(aText.substring(position, nextPosition));
  77
  78       if (nextPosition<aText.length())
  79         for (i=0; i<aCharactersToReplace.length; i++) {
  80           if (aCharactersToReplace[i] == aText.charAt(nextPosition)) {
  81             result.append(aStringsToSubstitute[i]);
  82             break;
  83           }
  84         }
  85       position=nextPosition+1;
  86     }
  87     while (nextPosition<aText.length()) ;
  88
  89     return result.toString();
  90   }
  91
  92
  93   public static String interpretAsString(Object aValue) throws Exception {
  94     if (aValue instanceof String)
  95       return (String) aValue;
  96
  97     if (aValue instanceof Integer)
  98       return ((Integer) aValue).toString();
  99
 100     if (aValue == null)
 101       return "";
 102
 103     throw new Exception("String expected, "+aValue+" found");
 104   }
 105
 106   public static int interpretAsInteger(Object aValue) throws Exception {
 107     if (aValue instanceof Integer)
 108       return ((Integer) aValue).intValue();
 109
 110     if (aValue instanceof String)
 111       try {
 112         return Integer.parseInt((String) aValue);
 113       }
 114       catch (Throwable t) {
 115         throw new Exception("Integer expected, "+aValue+" found");
 116       }
 117
 118     throw new Exception("Integer expected, "+aValue+" found");
 119   }
 120
 121   /**
 122    *
 123    * @param aSource
 124    * @param aSearchExpression
 125    * @param aReplacement
 126    * @return
 127    * @throws Exception
 128    */
 129   public static String performRegularExpressionReplacement(String aSource,
 130       String aSearchExpression, String aReplacement) throws Exception {
 131
 132     RE regularExpression;
 133
 134     regularExpression = new RE(aSearchExpression);
 135
 136     return regularExpression.substituteAll(aSource, aReplacement);
 137   }
 138
 139   /**
 140    *
 141    * @param aSource
 142    * @param aSearchExpression
 143    * @return
 144    * @throws REException
 145    */
 146   public static boolean performRegularExpressionSearch(String aSource,
 147       String aSearchExpression) throws REException {
 148     RE regularExpression;
 149
 150     regularExpression = new RE(aSearchExpression);
 151
 152     return regularExpression.isMatch(aSource);
 153   }
 154
 155   /**
 156    * Separates a string based on a separator:
 157    *     <code>seperateString("a:b:c", ":");</code> will lead to
 158    *     a List with 3 Strings: <code>"a"</code>, <code>"b"</code> and <code>"c"</code>
 159    *
 160    * @param aString     The string to split
 161    * @param aSeparator
 162    * @return
 163    */
 164
 165   public static List splitString(String aString, String aSeparator) {
 166     List result= new Vector();
 167     int previousPosition = 0;
 168     int position;
 169     int endOfNamePosition;
 170
 171     while ((position = aString.indexOf(aSeparator, previousPosition))>=0) {
 172       result.add(aString.substring(previousPosition, position));
 173       previousPosition = position + aSeparator.length();
 174     }
 175
 176     result.add(aString.substring(previousPosition, aString.length()));
 177
 178     return result;
 179   }
 180
 181   /**
 182    * Separates a String into at most 2 parts based on a separator:
 183    * <ul>
 184    *   <li>
 185    *     <code>seperateString("a:b:c", ":");</code> will lead to
 186    *     a List with 2 Strings: <code>"a"</code> and <code>"b:c"</code>
 187    *   <li>
 188    *     <code>seperateString("abc", ":");</code> will lead to
 189    *     a List with a single String: <code>"abc"</code>
 190    * </ul>
 191    *
 192    *
 193    * @param aString
 194    * @param aSeparator
 195    * @return
 196    */
 197   public static List separateString(String aString, String aSeparator) {
 198     List result= new Vector();
 199     int previousPosition = 0;
 200     int position;
 201     int endOfNamePosition;
 202
 203     if((position = aString.indexOf(aSeparator, previousPosition))>=0) {
 204       result.add(aString.substring(previousPosition, position));
 205       previousPosition = position + aSeparator.length();
 206     }
 207
 208     result.add(aString.substring(previousPosition, aString.length()));
 209
 210     return result;
 211   }
 212 }