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     int position, nextPosition;
  63     int i;
  64     StringBuffer result = new StringBuffer();
  65
  66     position=0;
  67
  68     do {
  69       nextPosition = StringRoutines.indexOfCharacters(aText, aCharactersToReplace, position);
  70
  71       if (nextPosition<0)
  72         nextPosition = aText.length();
  73
  74       result.append(aText.substring(position, nextPosition));
  75
  76       if (nextPosition<aText.length())
  77         for (i=0; i<aCharactersToReplace.length; i++) {
  78           if (aCharactersToReplace[i] == aText.charAt(nextPosition)) {
  79             result.append(aStringsToSubstitute[i]);
  80             break;
  81           }
  82         }
  83       position=nextPosition+1;
  84     }
  85     while (nextPosition<aText.length()) ;
  86
  87     return result.toString();
  88   }
  89
  90
  91   public static String interpretAsString(Object aValue) throws Exception {
  92     if (aValue instanceof String)
  93       return (String) aValue;
  94
  95     if (aValue instanceof Integer)
  96       return ((Integer) aValue).toString();
  97
  98     if (aValue == null)
  99       return "";
 100
 101     throw new Exception("String expected, "+aValue+" found");
 102   }
 103
 104   public static int interpretAsInteger(Object aValue) throws Exception {
 105     if (aValue instanceof Integer)
 106       return ((Integer) aValue).intValue();
 107
 108     if (aValue instanceof String)
 109       try {
 110         return Integer.parseInt((String) aValue);
 111       }
 112       catch (Throwable t) {
 113         throw new Exception("Integer expected, "+aValue+" found");
 114       }
 115
 116     throw new Exception("Integer expected, "+aValue+" found");
 117   }
 118
 119   /**
 120    *
 121    * @param aSource
 122    * @param aSearchExpression
 123    * @param aReplacement
 124    * @return
 125    * @throws Exception
 126    */
 127   public static String performRegularExpressionReplacement(String aSource,
 128       String aSearchExpression, String aReplacement) throws Exception {
 129
 130     RE regularExpression;
 131
 132     regularExpression = new RE(aSearchExpression);
 133
 134     return regularExpression.substituteAll(aSource, aReplacement);
 135   }
 136
 137   /**
 138    *
 139    * @param aSource
 140    * @param aSearchExpression
 141    * @return
 142    * @throws REException
 143    */
 144   public static boolean performRegularExpressionSearch(String aSource,
 145       String aSearchExpression) throws REException {
 146     RE regularExpression;
 147
 148     regularExpression = new RE(aSearchExpression);
 149
 150     return regularExpression.isMatch(aSource);
 151   }
 152
 153   /**
 154    * Separates a string based on a separator:
 155    *     <code>seperateString("a:b:c", ":");</code> will lead to
 156    *     a List with 3 Strings: <code>"a"</code>, <code>"b"</code> and <code>"c"</code>
 157    *
 158    * @param aString     The string to split
 159    * @param aSeparator
 160    * @return
 161    */
 162
 163   public static List splitString(String aString, String aSeparator) {
 164     List result= new Vector();
 165     int previousPosition = 0;
 166     int position;
 167     int endOfNamePosition;
 168
 169     while ((position = aString.indexOf(aSeparator, previousPosition))>=0) {
 170       result.add(aString.substring(previousPosition, position));
 171       previousPosition = position + aSeparator.length();
 172     }
 173
 174     result.add(aString.substring(previousPosition, aString.length()));
 175
 176     return result;
 177   }
 178
 179   /**
 180    * Separates a String into at most 2 parts based on a separator:
 181    * <ul>
 182    *   <li>
 183    *     <code>seperateString("a:b:c", ":");</code> will lead to
 184    *     a List with 2 Strings: <code>"a"</code> and <code>"b:c"</code>
 185    *   <li>
 186    *     <code>seperateString("abc", ":");</code> will lead to
 187    *     a List with a single String: <code>"abc"</code>
 188    * </ul>
 189    *
 190    *
 191    * @param aString
 192    * @param aSeparator
 193    * @return
 194    */
 195   public static List separateString(String aString, String aSeparator) {
 196     List result= new Vector();
 197     int previousPosition = 0;
 198     int position;
 199     int endOfNamePosition;
 200
 201     if((position = aString.indexOf(aSeparator, previousPosition))>=0) {
 202       result.add(aString.substring(previousPosition, position));
 203       previousPosition = position + aSeparator.length();
 204     }
 205
 206     result.add(aString.substring(previousPosition, aString.length()));
 207
 208     return result;
 209   }
 210 }