net.rim.device.api.util
Class StringUtilities

java.lang.Object
  |
  +--net.rim.device.api.util.StringUtilities

public final class StringUtilities

extends Object

Utility methods for manipulating Strings.

Method Summary

static int	compareObjectToStringIgnoreCase(Object o1, Object o2) Compares the string form of two objects, ignoring case.
static int	compareToIgnoreCase(String s1, String s2) Compare two strings, ignoring case.
static int	computeHashCode(StringBuffer stringBuffer) Retrieves hashcode of provided string buffer.
static int	computeReverseLookupHashCodeBytes(byte[] bytes, int start, int length) Retrieves restricted hashcode for section of a byte array.
static int	computeReverseLookupHashCodeString(String string) Retrieves restricted hashcode for string (for use in reverse lookups).
static String	cStr2String(byte[] b, int start, int len) Converts C/C++ string into a Java String.
static int	indexOf(String string, char ch, int fromIndex, int toIndex) Retrieves first occurence of character in section of provided string.
static String	removeChars(String src, String remove) Removes specified characters from a string.
static boolean	startsWithIgnoreCase(String string, String prefix) Determines if target string begins with provided prefix.
static boolean	startsWithIgnoreCaseAndAccents(String string, String prefix) NEW NEW NEW Determine if target string begins with a provided prefix, igoring the case and accents of the characters in the string.
static boolean	strEqual(String s1, String s2) Compares two (possibly null) strings for equality.
static boolean	strEqualIgnoreCase(String s1, String s2) Compares two (possibly null) strings for equality, ignoring their case.
static String[]	stringToWords(String string) Extracts word tokens from provided string.
static int	stringToWords(String stringContainingWords, int[] indexResults, int resultOffset) Parses string into words.
static int	stringToWords(String string, String[] wordArray, int index) Extracts word tokens from provided string, placing them into provided array.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

compareToIgnoreCase

public static int compareToIgnoreCase(String s1,
                                      String s2)

Compare two strings, ignoring case.

No attempt is currently made to pay attention to ASCII ordering.

Parameters:

s1 - First string to compare.

s2 - Second string to compare.

Returns:

Value less than zero if first string sorts before the second; zero if the two strings are the same; value greater than zero if the first string sorts after the second.

Since:

JDE 3.6

computeHashCode

public static int computeHashCode(StringBuffer stringBuffer)

Retrieves hashcode of provided string buffer.

An identical hashcode would be produced for a String instance containing the same data.

Parameters:

stringBuffer - String buffer for which to retrieve a hashcode.

Returns:

Hashcode of string buffer.

Since:

JDE 3.6

computeReverseLookupHashCodeString

public static int computeReverseLookupHashCodeString(String string)

Retrieves restricted hashcode for string (for use in reverse lookups).

The hash only considers alphas, numbers, and the @ sign, with all characters being lower case.

Parameters:

string - String for which to retrieve the hashcode.

Returns:

Hashcode of string.

Since:

JDE 3.6

computeReverseLookupHashCodeBytes

public static int computeReverseLookupHashCodeBytes(byte[] bytes,
                                                    int start,
                                                    int length)

Retrieves restricted hashcode for section of a byte array.

The hash only considers alphas, numbers, and the @ sign, with all characters being lower case.

Parameters:

bytes - Byte array containing section for which to retrieve the hashcode.

start - First element to include in the compuatation.

length - Number of bytes to include in the computation.

Returns:

Hashcode of section of byte array.

Since:

JDE 3.6

stringToWords

public static int stringToWords(String stringContainingWords,
                                int[] indexResults,
                                int resultOffset)
                         throws ArrayIndexOutOfBoundsException

Parses string into words.

This method computes the positions of words in a target string. A word is a contiguous block of upper case and lower case characters, with the adjecent characters at either end, if they exist, not being upper or lower case.

If the result array is not large enough to hold the computed indexes a ArrayOfOutOfBounds exception is thrown

Parameters:

stringContainingWords - Target string to parse.

indexResults - Array of word positions in the target string.

indexOffset - First element of the results array to contain first word position for the target string.

Returns:

Total number of words found in target string.

Throws:

ArrayIndexOutOfBoundsException - If the results array is not large enough to contain positions of all the words found in the target string.

Since:

JDE 3.6

startsWithIgnoreCase

public static boolean startsWithIgnoreCase(String string,
                                           String prefix)

Determines if target string begins with provided prefix.

Parameters:

string - Target string to check.

prefix - Prefix to look for.

Returns:

True if target string starts with provided prefix; otherwise, false.

Since:

JDE 3.6

startsWithIgnoreCaseAndAccents

public static boolean startsWithIgnoreCaseAndAccents(String string,
                                                     String prefix)

NEW NEW NEW Determine if target string begins with a provided prefix, igoring the case and accents of the characters in the string.

Parameters:

string - The Target string to check.

prefix - The prefix to look for.

Returns:

true if the target string starts with the provided prefix; otherwise false.

Since:

JDE 3.6

stringToWords

public static String[] stringToWords(String string)

Extracts word tokens from provided string.

A word is a contiguous block of upper case and lower case characters, with the adjecent characters at either end, if they exist, not being upper or lower case.

Parameters:

string - String to tokenize.

Returns:

Array of words found in provided string.

Since:

JDE 3.6

stringToWords

public static int stringToWords(String string,
                                String[] wordArray,
                                int index)

Extracts word tokens from provided string, placing them into provided array.

A word is a contiguous block of upper case and lower case characters, with the adjecent characters at either end, if they exist, not being alphanumeric.

Parameters:

string - String to tokenize.

wordArray - Array to contain the word tokens found in provided string.

index - Position in the word array at which to start adding words found in provided string.

Returns:

Number of words extracted from provided string.

Since:

JDE 3.6

strEqualIgnoreCase

public static boolean strEqualIgnoreCase(String s1,
                                         String s2)

Compares two (possibly null) strings for equality, ignoring their case.

No attempt is currently made to pay attention to ASCII ordering. Two null strings are considered equal.

Parameters:

s1 - First string to compare.

s2 - Second string to compare.

Returns:

True if the two strings are equal; otherwise, false.

Since:

JDE 3.6

strEqual

public static boolean strEqual(String s1,
                               String s2)

Compares two (possibly null) strings for equality.

Two null strings are considered equal.

Parameters:

s1 - First string to compare.

s2 - Second string to compare.

Returns:

True if the two strings are equal; otherwise, false.

Since:

JDE 3.6

cStr2String

public static final String cStr2String(byte[] b,
                                       int start,
                                       int len)

Converts C/C++ string into a Java String.

This method strips off the trailing nulls. Use this instead of String.trim() if you don't want to end up creating two string objects.

Parameters:

b - Byte array containing C/C++ string data.

start - First byte in the C/C++ string.

len - Length of the C/C++ string (this may include nulls that this method will strip.

Returns:

Java String form of provided C/C++ string.

Since:

JDE 3.6

compareObjectToStringIgnoreCase

public static int compareObjectToStringIgnoreCase(Object o1,
                                                  Object o2)

Compares the string form of two objects, ignoring case.

This method invokes Object.toString() on both provided objects, and then compares the two return values for equality. No attempt is currently made to pay attention to ASCII ordering. A null object sorts before a non-null object.

Parameters:

o1 - First object to compare.

o2 - Second object to compare.

Returns:

Value less than zero if first object's string form sorts before second; zero if both string forms are equal; value greater than zero if first object's string form sorts after second.

Since:

JDE 3.6

indexOf

public static int indexOf(String string,
                          char ch,
                          int fromIndex,
                          int toIndex)

Retrieves first occurence of character in section of provided string.

Parameters:

string - String containing section search.

ch - Character to look for.

fromIndex - First element in string to look at. If this value is less than 0, this method assumes it has the value 0. If this value is greater than the toIndex parameter, this method assumes it has the same value as the toIndex parameter.

toIndex - Last element in string to look at. If this value is greater than the length of the string, this method assumes it has the same value as the length of the string.

Returns:

Index of the first occurence of the character within the section of the string searched. If the fromIndex parameter is greater than, or equal to the toIndex parameter, then this method returns -1. This method also returns -1 if it cannot find an occurence of the character in the section of the string searched.

Since:

JDE 3.6

removeChars

public static String removeChars(String src,
                                 String remove)

Removes specified characters from a string.

Parameters:

src - Source string; may not be null.

remove - String containing characters to remove from source string; may not be null.

Returns:

Resulting string with characters removed.

Since:

JDE 3.6