Organizing import, refresh the license (zapata deleted cos.jar)
[mir.git] / 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 import gnu.regexp.REException;
34
35 import java.util.List;
36 import java.util.Vector;
37
38 public class StringRoutines {
39
40   private StringRoutines() {
41   }
42
43   static int indexOfCharacters(String aString, char[] aCharacters, int aFrom) {
44     int i;
45     int result=-1;
46     int position;
47
48     for (i=0; i<aCharacters.length ; i++) {
49       position = aString.indexOf(aCharacters[i], aFrom);
50
51       if (position != -1 && ( result == -1 || position < result )) {
52         result = position;
53       }
54     }
55
56     return result;
57   }
58
59   static String replaceStringCharacters(String aText, char[] aCharactersToReplace, String[] aStringsToSubstitute) {
60     if (aText==null)
61       return null;
62
63     int position, nextPosition;
64     int i;
65     StringBuffer result = new StringBuffer();
66
67     position=0;
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     if (aString!=null) {
170       while ( (position = aString.indexOf(aSeparator, previousPosition)) >= 0) {
171         result.add(aString.substring(previousPosition, position));
172         previousPosition = position + aSeparator.length();
173       }
174       result.add(aString.substring(previousPosition, aString.length()));
175     }
176
177     return result;
178   }
179
180   /**
181    * Separates a String into at most 2 parts based on a separator:
182    * <ul>
183    *   <li>
184    *     <code>seperateString("a:b:c", ":");</code> will lead to
185    *     a List with 2 Strings: <code>"a"</code> and <code>"b:c"</code>
186    *   <li>
187    *     <code>seperateString("abc", ":");</code> will lead to
188    *     a List with a single String: <code>"abc"</code>
189    * </ul>
190    *
191    *
192    * @param aString
193    * @param aSeparator
194    * @return
195    */
196   public static List separateString(String aString, String aSeparator) {
197     List result= new Vector();
198     int previousPosition = 0;
199     int position;
200     int endOfNamePosition;
201
202     if((position = aString.indexOf(aSeparator, previousPosition))>=0) {
203       result.add(aString.substring(previousPosition, position));
204       previousPosition = position + aSeparator.length();
205     }
206
207     result.add(aString.substring(previousPosition, aString.length()));
208
209     return result;
210   }
211 }