com.mockrunner.util.common.StringUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mockrunner-core Show documentation
Show all versions of mockrunner-core Show documentation
Core classes common to all Mockrunner modules
package com.mockrunner.util.common;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.oro.text.regex.MalformedPatternException;
import org.apache.oro.text.regex.Pattern;
import org.apache.oro.text.regex.Perl5Compiler;
import org.apache.oro.text.regex.Perl5Matcher;
import com.mockrunner.base.NestedApplicationException;
/**
* Simple util class for String related methods.
*/
public class StringUtil
{
/**
* Returns if the specified string is null or
* the empty string.
* @param string the string
* @return true if the specified string is null or
* the empty string, false otherwise
*/
public static boolean isEmptyOrNull(String string)
{
return (null == string) || (0 >= string.length());
}
/**
* Returns null, if the specified string is null or
* the empty string. Returns the specified string otherwise.
* @param string the string
* @return null if the specified string is null or
* the empty string, the specified string otherwise
*/
public static String emptyStringToNull(String string)
{
return isEmptyOrNull(string) ? null : string;
}
/**
* Replaces all occurrences of match in
* source with replacement.
* @param source the source string
* @param match the string that is searched
* @param replacement the replacement string
* @return the modified string
* @throws IllegalArgumentException if any argument is null or
* if match is the empty string
*/
public static String replaceAll(String source, String match, String replacement)
{
if(null == source || null == match || null == replacement)
{
throw new IllegalArgumentException("null strings not allowed");
}
if(match.length() <= 0)
{
throw new IllegalArgumentException("match must not be empty");
}
StringBuffer buffer = new StringBuffer(source.length() + 10);
int index = 0;
int newIndex = 0;
while((newIndex = source.indexOf(match, index)) >= 0)
{
buffer.append(source.substring(index, newIndex));
buffer.append(replacement);
index = newIndex + match.length();
}
buffer.append(source.substring(index));
return buffer.toString();
}
/**
* Compares two strings and returns the last
* index where the two string are equal. If
* the first characters of the two string do
* not match or if at least one of the two strings
* is empty, -1 is returned.
* @param string1 the first string
* @param string2 the second string
* @return the last index where the strings are equal
*/
public static int compare(String string1, String string2)
{
int endIndex = Math.min(string1.length(), string2.length());
for(int ii = 0; ii < endIndex; ii++)
{
if(string1.charAt(ii) != string2.charAt(ii)) return ii - 1;
}
return endIndex - 1;
}
/**
* Converts the character at the specified index to
* lowercase and returns the resulting string.
* @param string the string to convert
* @param index the index where the character is set to lowercase
* @return the converted string
* @throws IndexOutOfBoundsException if the index is out of
* range
*/
public static String lowerCase(String string, int index)
{
return lowerCase(string, index, -1);
}
/**
* Converts the character in the specified index range to
* lowercase and returns the resulting string.
* If the provided endIndex is smaller or equal to startIndex,
* the endIndex is set to startIndex + 1.
* @param string the string to convert
* @param startIndex the index to start, inclusive
* @param endIndex the index to end, exclusive
* @return the converted string
* @throws IndexOutOfBoundsException if the index is out of
* range
*/
public static String lowerCase(String string, int startIndex, int endIndex)
{
StringBuffer buffer = new StringBuffer(string);
if(endIndex <= startIndex) endIndex = startIndex + 1;
for(int ii = startIndex; ii < endIndex; ii++)
{
char character = buffer.charAt(ii);
buffer.setCharAt(ii, Character.toLowerCase(character));
}
return buffer.toString();
}
/**
* Helper method for toString() implementations.
* Returns a string "field name: value". Handles
* null values, collections and arrays. If the
* field is a collection or an array, the returned string will
* be:
* "field name 0: value0\nfield name 1: value1"
* @param fieldName the field name
* @param field the field value
* @return a suitable string for toString() implementations
*/
public static String fieldToString(String fieldName, Object field)
{
StringBuffer buffer = new StringBuffer();
if(null == field)
{
buffer.append(fieldName + ": " + "null");
}
else if(field.getClass().isArray())
{
arrayToString(fieldName, field, buffer);
}
else if(field instanceof Collection)
{
collectionToString(fieldName, field, buffer);
}
else if(field instanceof Map)
{
mapToString(fieldName, field, buffer);
}
else
{
buffer.append(fieldName + ": " + field.toString());
}
return buffer.toString();
}
private static void arrayToString(String fieldName, Object field, StringBuffer buffer)
{
int length = Array.getLength(field);
if(0 >= length)
{
buffer.append(fieldName + ": " + "empty");
}
else
{
for(int ii = 0; ii < length; ii++)
{
buffer.append(fieldToString(fieldName + " " + ii, Array.get(field, ii)));
if(ii < length - 1)
{
buffer.append("\n");
}
}
}
}
private static void collectionToString(String fieldName, Object field, StringBuffer buffer)
{
List list = new ArrayList((Collection)field);
if(0 >= list.size())
{
buffer.append(fieldName + ": " + "empty");
}
else
{
for(int ii = 0; ii < list.size(); ii++)
{
buffer.append(fieldToString(fieldName + " " + ii, list.get(ii)));
if(ii < list.size() - 1)
{
buffer.append("\n");
}
}
}
}
private static void mapToString(String fieldName, Object field, StringBuffer buffer)
{
if(0 >= ((Map)field).size())
{
buffer.append(fieldName + ": " + "empty");
}
else
{
Iterator keys = ((Map)field).keySet().iterator();
int ii = 0;
while(keys.hasNext())
{
Object key = keys.next();
Object value = ((Map)field).get(key);
buffer.append(fieldToString(fieldName + " " + key, value));
if(ii < ((Map)field).size() - 1)
{
buffer.append("\n");
}
ii++;
}
}
}
/**
* Appends the entries in the specified List as strings
* with a terminating "\n" after each row.
* @param buffer the buffer
* @param data the List with the data
*/
public static void appendObjectsAsString(StringBuffer buffer, List data)
{
for(int ii = 0; ii < data.size(); ii++)
{
buffer.append(data.get(ii));
buffer.append("\n");
}
}
/**
* Appends number tabs (\t) to the buffer.
* @param buffer the buffer
* @param number the number of tabs to append
*/
public static void appendTabs(StringBuffer buffer, int number)
{
for(int ii = 0; ii < number; ii++)
{
buffer.append("\t");
}
}
/**
* Splits a string into tokens. Similar to StringTokenizer
* except that empty tokens are recognized and added as null.
* With a delimiter of ";" the string
* "a;;b;c;;" will split into
* ["a"] [null] ["b"] ["c"] [null].
* @param string the String
* @param delim the delimiter
* @param doTrim should each token be trimmed
* @return the array of tokens
*/
public static String[] split(String string, String delim, boolean doTrim)
{
int pos = 0, begin = 0;
ArrayList resultList = new ArrayList();
while((-1 != (pos = string.indexOf(delim, begin))) && (begin < string.length()))
{
String token = string.substring(begin, pos);
if(doTrim) token = token.trim();
if(token.length() == 0) token = null;
resultList.add(token);
begin = pos + delim.length();
}
if(begin < string.length())
{
String token = string.substring(begin);
if(doTrim) token = token.trim();
if(token.length() == 0) token = null;
resultList.add(token);
}
return (String[])resultList.toArray(new String[resultList.size()]);
}
/**
* Returns how many times string contains
* other.
* @param string the string to search
* @param other the string that is searched
* @return the number of occurences
*/
public static int countMatches(String string, String other)
{
if(null == string) return 0;
if(null == other) return 0;
if(0 >= string.length()) return 0;
if(0 >= other.length()) return 0;
int count = 0;
int index = 0;
while((index <= string.length() - other.length()) && (-1 != (index = string.indexOf(other, index))))
{
count++;
index += other.length();
}
return count;
}
/**
* Returns if the specified strings are equal, ignoring
* case, if caseSensitive is false.
* @param source the source String
* @param target the target String
* @param caseSensitive is the comparison case sensitive
* @return true if the strings matches
* false otherwise
*/
public static boolean matchesExact(String source, String target, boolean caseSensitive)
{
if(!caseSensitive)
{
source = source.toLowerCase();
target = target.toLowerCase();
}
return (source.equals(target));
}
/**
* Returns if source contains target,
* ignoring case, if caseSensitive is false.
* @param source the source String
* @param target the target String
* @param caseSensitive is the comparison case sensitive
* @return true if the strings matches
* false otherwise
*/
public static boolean matchesContains(String source, String target, boolean caseSensitive)
{
if(!caseSensitive)
{
source = source.toLowerCase();
target = target.toLowerCase();
}
return (-1 != source.indexOf(target));
}
/**
* Returns if the regular expression target matches
* source, ignoring case, if caseSensitive
* is false.
* @param source the source String
* @param target the target String
* @param caseSensitive is the comparison case sensitive
* @return true if the strings matches
* false otherwise
*/
public static boolean matchesPerl5(String source, String target, boolean caseSensitive)
{
int mask = Perl5Compiler.CASE_INSENSITIVE_MASK;
if(caseSensitive)
{
mask = Perl5Compiler.DEFAULT_MASK;
}
try
{
Pattern pattern = new Perl5Compiler().compile(target, mask);
return (new Perl5Matcher().matches(source, pattern));
}
catch(MalformedPatternException exc)
{
throw new NestedApplicationException(exc);
}
}
}