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  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.util;
  31
  32 import gnu.regexp.RE;
  33
  34 import java.util.ArrayList;
  35 import java.util.List;
  36
  37 public class StringRoutines {
  38
  39   private StringRoutines() {
  40   }
  41
  42   public static int indexOfCharacters(String aString, char[] aCharacters, int aFrom) {
  43     int i;
  44     int result=-1;
  45     int position;
  46
  47     for (i=0; i<aCharacters.length ; i++) {
  48       position = aString.indexOf(aCharacters[i], aFrom);
  49
  50       if (position != -1 && ( result == -1 || position < result )) {
  51         result = position;
  52       }
  53     }
  54
  55     return result;
  56   }
  57
  58   public static String replaceStringCharacters(String aText, char[] aCharactersToReplace, String[] aStringsToSubstitute) {
  59     if (aText==null)
  60       return null;
  61
  62     int position, nextPosition;
  63     int i;
  64     StringBuffer result = new StringBuffer();
  65
  66     position=0;
  67     do {
  68       nextPosition = StringRoutines.indexOfCharacters(aText, aCharactersToReplace, position);
  69
  70       if (nextPosition<0)
  71         nextPosition = aText.length();
  72
  73       result.append(aText.substring(position, nextPosition));
  74
  75       if (nextPosition<aText.length())
  76         for (i=0; i<aCharactersToReplace.length; i++) {
  77           if (aCharactersToReplace[i] == aText.charAt(nextPosition)) {
  78             result.append(aStringsToSubstitute[i]);
  79             break;
  80           }
  81         }
  82       position=nextPosition+1;
  83     }
  84     while (nextPosition<aText.length()) ;
  85
  86     return result.toString();
  87   }
  88   /**
  89    */
  90
  91   public static String replaceEscapedStringCharacters(String aText, char anEscapeCharacter, char[] aCharactersToReplace, String[] aStringsToSubstitute) {
  92     if (aText==null)
  93       return null;
  94
  95     int position, nextPosition;
  96     int i;
  97     StringBuffer result = new StringBuffer();
  98
  99     position=0;
 100     do {
 101       nextPosition = aText.indexOf(anEscapeCharacter, position);
 102
 103       if (nextPosition<0)
 104         nextPosition = aText.length();
 105
 106       result.append(aText.substring(position, nextPosition));
 107
 108       if (nextPosition+1<aText.length()) {
 109         nextPosition = nextPosition+1;
 110
 111         boolean found = false;
 112         for (i = 0; i < aCharactersToReplace.length; i++) {
 113           if (aCharactersToReplace[i] == aText.charAt(nextPosition)) {
 114             result.append(aStringsToSubstitute[i]);
 115             found=true;
 116             break;
 117           }
 118         }
 119
 120         if (!found) {
 121           result.append(aText.charAt(nextPosition));
 122         }
 123       }
 124       position=nextPosition+1;
 125     }
 126     while (nextPosition<aText.length()) ;
 127
 128     return result.toString();
 129   }
 130
 131   public static String interpretAsString(Object aValue) throws Exception {
 132     if (aValue instanceof String)
 133       return (String) aValue;
 134
 135     if (aValue instanceof Integer)
 136       return aValue.toString();
 137
 138     if (aValue == null)
 139       return "";
 140
 141     throw new Exception("String expected, "+aValue+" found");
 142   }
 143
 144   public static int interpretAsInteger(Object aValue) throws Exception {
 145     if (aValue instanceof Integer)
 146       return ((Integer) aValue).intValue();
 147
 148     if (aValue instanceof String)
 149       try {
 150         return Integer.parseInt((String) aValue);
 151       }
 152       catch (Throwable t) {
 153         throw new Exception("Integer expected, "+aValue+" found");
 154       }
 155
 156     throw new Exception("Integer expected, "+aValue+" found");
 157   }
 158
 159   public static String performRegularExpressionReplacement(String aSource, String aSearchExpression, String aReplacement) {
 160     try {
 161       RE regularExpression;
 162
 163       regularExpression = new RE(aSearchExpression);
 164
 165       return regularExpression.substituteAll(aSource, aReplacement);
 166     }
 167     catch (Throwable t) {
 168       throw new UtilFailure("StringRoutines.performRegularExpressionReplacement: " + t.toString(), t);
 169     }
 170   }
 171
 172   /**
 173    * Separates a string based on a separator:
 174    *     <code>seperateString("a:b:c", ":");</code> will lead to
 175    *     a List with 3 Strings: <code>"a"</code>, <code>"b"</code> and <code>"c"</code>
 176    *
 177    * @param aString     The string to split
 178    * @param aSeparator
 179    * @return
 180    */
 181
 182   public static List splitString(String aString, String aSeparator) {
 183     List result= new ArrayList();
 184     int previousPosition = 0;
 185     int position;
 186
 187     if (aString!=null) {
 188       while ( (position = aString.indexOf(aSeparator, previousPosition)) >= 0) {
 189         result.add(aString.substring(previousPosition, position));
 190         previousPosition = position + aSeparator.length();
 191       }
 192       result.add(aString.substring(previousPosition, aString.length()));
 193     }
 194
 195     return result;
 196   }
 197
 198   /**
 199    * Separates a String into at most 2 parts based on a separator:
 200    * <ul>
 201    *   <li>
 202    *     <code>seperateString("a:b:c", ":");</code> will lead to
 203    *     a List with 2 Strings: <code>"a"</code> and <code>"b:c"</code>
 204    *   <li>
 205    *     <code>seperateString("abc", ":");</code> will lead to
 206    *     a List with a single String: <code>"abc"</code>
 207    * </ul>
 208    *
 209    *
 210    * @param aString
 211    * @param aSeparator
 212    * @return
 213    */
 214   public static List separateString(String aString, String aSeparator) {
 215     List result= new ArrayList();
 216     int previousPosition = 0;
 217     int position;
 218
 219     if((position = aString.indexOf(aSeparator, previousPosition))>=0) {
 220       result.add(aString.substring(previousPosition, position));
 221       previousPosition = position + aSeparator.length();
 222     }
 223
 224     result.add(aString.substring(previousPosition, aString.length()));
 225
 226     return result;
 227   }
 228
 229   /**
 230    * Separates a string based on a separator, taking into account an escape character:
 231    *     <code>seperateString("a:/::b", ":", "/");</code> will lead to
 232    *     a List with 3 Strings: <code>"a"</code>, <code>":"</code> and <code>"b"</code>
 233    *
 234    * @param aString     The string to split
 235    * @param aSeparator
 236    * @return
 237    */
 238
 239   public static List splitStringWithEscape(String aString, char aSeparator, char anEscape) {
 240     List result= new ArrayList();
 241     int previousPosition = 0;
 242     int position;
 243
 244     StringBuffer currentItem = new StringBuffer();
 245
 246     if (aString!=null && aString.length()>0) {
 247       while ((position = indexOfCharacters(aString, new char[] {aSeparator, anEscape}, previousPosition))>=0) {
 248         currentItem.append(aString.substring(previousPosition, position));
 249
 250         if (aString.charAt(position)==aSeparator) {
 251           result.add(currentItem.toString());
 252           currentItem.delete(0, currentItem.length());
 253         }
 254         else {
 255           if (aString.length()>position+1) {
 256             position=position+1;
 257             currentItem.append(aString.charAt(position));
 258           }
 259           else {
 260             currentItem.append(aString.charAt(position));
 261           }
 262         }
 263         previousPosition = position + 1;
 264       }
 265       currentItem.append(aString.substring(previousPosition, aString.length()));
 266       result.add(currentItem.toString());
 267     }
 268
 269     return result;
 270   }
 271
 272   public static String replicateString(String aString, int aCount) {
 273     StringBuffer result = new StringBuffer();
 274
 275     for (int i=0; i<aCount; i++)
 276       result.append(aString);
 277
 278     return result.toString();
 279   }
 280
 281   public static String replicateChar(char aCharacter, int aCount) {
 282     char result[] = new char[aCount];
 283
 284     for (int i=0; i<aCount; i++)
 285       result[i]= aCharacter;
 286
 287     return new String(result);
 288   }
 289
 290   public static String padStringLeft(String aString, int aLength, char aPadCharacter) {
 291     if (aString.length()<aLength)
 292       return replicateChar(aPadCharacter, aLength-aString.length()) + aString;
 293                 return aString;
 294   }
 295
 296   private static final char HEX_CHARACTERS[] = {
 297       '0', '1', '2', '3', '4', '5', '6', '7',
 298       '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'
 299   };
 300
 301   public static String convertToHex(long aData, int aNumberOfDigits) {
 302     StringBuffer result = new StringBuffer();
 303
 304     for (int digit = aNumberOfDigits-1; digit>=0; digit--) {
 305       int value = (int) (aData >> (digit*4)) & 0xf;
 306       result.append(HEX_CHARACTERS[value]);
 307     }
 308
 309     return result.toString();
 310   }
 311
 312   public static String convertToHex(byte[] aData) {
 313     StringBuffer result = new StringBuffer();
 314
 315     for (int i = 0; i<aData.length; i++) {
 316       result.append(convertToHex(aData[i], 2));
 317
 318     }
 319
 320     return result.toString();
 321   }
 322 }