com.wantedtech.common.xpresso.strings

Class HappyString

java.lang.Object

com.wantedtech.common.xpresso.strings.HappyString

Direct Known Subclasses:

Token

public class HappyString
extends java.lang.Object

This class contains high-level static utility methods. It can be seen as a container of the highest-level methods of xpresso, similar to Python's __builtin__ namespace.

Since:

0.1

Author:

Andriy Burkov

Constructor Summary

Constructors

Constructor and Description
HappyString(java.lang.String string) This class clones the String object functionality and adds with additional methods, such as join(java.lang.Iterable<?>), split(java.lang.String, int), and in(java.lang.String...).

Method Summary

Modifier and Type	Method and Description
java.lang.String	capitalize()
char	charAt(int index) Returns the char value at the specified index.
int	codePointAt(int index) Returns the character (Unicode code point) at the specified index.
int	codePointBefore(int index) Returns the character (Unicode code point) before the specified index.
int	codePointCount(int beginIndex, int endIndex) Returns the number of Unicode code points in the specified text range of this String.
int	compareTo(java.lang.String anotherString) Compares two strings lexicographically.
int	compareToIgnoreCase(java.lang.String str) Compares two strings lexicographically, ignoring case differences.
java.lang.String	compress()
java.lang.String	concat(java.lang.String str) Concatenates the specified string to the end of this string.
boolean	contains(java.lang.CharSequence s) Returns true if and only if this string contains the specified sequence of char values.
boolean	contentEquals(java.lang.CharSequence cs) Compares this string to the specified CharSequence.
boolean	contentEquals(java.lang.StringBuffer sb) Compares this string to the specified StringBuffer.
int	count(char character)
int	count(java.lang.String substring)
boolean	endsWith(java.lang.String suffix) Tests if this string ends with the specified suffix.
boolean	equals(java.lang.Object anObject) Compares this string to the specified object.
boolean	equalsIgnoreCase(java.lang.String anotherString) Compares this String to another String, ignoring case considerations.
java.lang.String	get(int index)
byte[]	getBytes() Encodes this String into a sequence of bytes using the platform's default charset, storing the result into a new byte array.
byte[]	getBytes(java.nio.charset.Charset charset) Encodes this String into a sequence of bytes using the given charset, storing the result into a new byte array.
byte[]	getBytes(java.lang.String charsetName) Encodes this String into a sequence of bytes using the named charset, storing the result into a new byte array.
void	getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) Copies characters from this string into the destination character array.
int	hashCode() Returns a hash code for this string.
boolean	in(java.lang.Iterable<java.lang.String> iterable)
boolean	in(str str)
boolean	in(java.lang.String... elements)
boolean	in(java.lang.String string)
int	indexOf(int ch) Returns the index within this string of the first occurrence of the specified character.
int	indexOf(int ch, int fromIndex) Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.
int	indexOf(java.lang.String str) Returns the index within this string of the first occurrence of the specified substring.
int	indexOf(java.lang.String str, int fromIndex) Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.
boolean	isEmpty() Returns true if, and only if, length() is 0.
java.lang.String	join(java.lang.Iterable<?> parts)
java.lang.String	join(java.util.Iterator<?> parts)
java.lang.String	join(java.lang.String... parts)
int	lastIndexOf(int ch) Returns the index within this string of the last occurrence of the specified character.
int	lastIndexOf(int ch, int fromIndex) Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index.
int	lastIndexOf(java.lang.String str) Returns the index within this string of the last occurrence of the specified substring.
int	lastIndexOf(java.lang.String str, int fromIndex) Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the specified index.
int	length() Returns the length of this string.
list<java.lang.String>	lookAlikes(java.lang.Iterable<java.lang.String> candidates)
list<java.lang.String>	lookAlikes(java.lang.Iterable<java.lang.String> candidates, double threshold)
java.lang.String	lower()
boolean	matches(java.lang.String regex) Tells whether or not this string matches the given regular expression.
boolean	notEquals(str str)
boolean	notEquals(java.lang.String string)
boolean	notIn(java.lang.Iterable<java.lang.String> iterable)
boolean	notIn(java.lang.String... elements)
boolean	notIn(java.lang.String string)
int	offsetByCodePoints(int index, int codePointOffset) Returns the index within this String that is offset from the given index by codePointOffset code points.
<T> T	parseJson() Factory method that creates a new instance of xpresso base type (dict, list, etc) object from a valid Json object string representation.
boolean	regionMatches(boolean ignoreCase, int toffset, java.lang.String other, int ooffset, int len) Tests if two string regions are equal.
boolean	regionMatches(int toffset, java.lang.String other, int ooffset, int len) Tests if two string regions are equal.
java.lang.String	replace(char oldChar, char newChar) Returns a new string resulting from replacing all occurrences of oldChar in this string with newChar.
java.lang.String	replace(java.lang.CharSequence target, java.lang.CharSequence replacement) Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence.
java.lang.String	replaceAll(java.lang.String regex, java.lang.String replacement) Replaces each substring of this string that matches the given regular expression with the given replacement.
java.lang.String	replaceFirst(java.lang.String regex, java.lang.String replacement) Replaces the first substring of this string that matches the given regular expression with the given replacement.
int	search(java.lang.String anotherString)
double	search(java.lang.String anotherString, int approximateLocation)
double	search(java.lang.String anotherString, int approximateLocation, double threshold)
double	similarity(java.lang.String anotherString)
java.lang.String	slice()
java.lang.String	slice(int step)
java.lang.String	slice(int startIndex, int endIndex)
java.lang.String	slice(int startIndex, int endIndex, int step)
java.lang.String	sliceFrom(int startIndex)
java.lang.String	sliceFrom(int startIndex, int step)
java.lang.String	sliceTo(int endIndex)
java.lang.String	sliceTo(int endIndex, int step)
list<java.lang.String>	split()
list<java.lang.String>	split(Regex regex, int limit) Splits this string around matches of the given regular expression.
list<java.lang.String>	split(java.lang.String regex) Splits this string around matches of the given regular expression.
list<java.lang.String>	split(java.lang.String regex, int limit)
boolean	startsWith(java.lang.String prefix) Tests if this string starts with the specified prefix.
boolean	startsWith(java.lang.String prefix, int toffset) Tests if the substring of this string beginning at the specified index starts with the specified prefix.
java.lang.String	strip()
java.lang.String	strip(java.lang.String chars)
java.lang.String	stripAccents()
java.lang.CharSequence	subSequence(int beginIndex, int endIndex) Returns a new character sequence that is a subsequence of this sequence.
java.lang.String	substring(int beginIndex) Returns a new string that is a substring of this string.
java.lang.String	substring(int beginIndex, int endIndex) Returns a new string that is a substring of this string.
java.lang.String	times(int multiplier)
java.lang.String	title()
char[]	toCharArray() Converts this string to a new character array.
java.lang.String	toLowerCase() Converts all of the characters in this String to lower case using the rules of the default locale.
java.lang.String	toLowerCase(java.util.Locale locale) Converts all of the characters in this String to lower case using the rules of the given Locale.
java.lang.String	toString() This object (which is already a string!) is itself returned.
java.lang.String	toUpperCase() Converts all of the characters in this String to upper case using the rules of the default locale.
java.lang.String	toUpperCase(java.util.Locale locale) Converts all of the characters in this String to upper case using the rules of the given Locale.
java.lang.String	translate(list<tuple> fromTo)
java.lang.String	translit()
java.lang.String	trim() Returns a copy of the string, with leading and trailing whitespace omitted.
java.lang.String	unidecode()
java.lang.String	upper()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HappyString

public HappyString(java.lang.String string)

This class clones the String object functionality and adds with additional methods, such as join(java.lang.Iterable<?>), split(java.lang.String, int), and in(java.lang.String...). Example 1: boolean q = x.String("na").in("banana"); x.print(q); Console: true Example 2: String s = x.String("|").join(x.listOf("a","b","c")); x.print(s); Console: a|b|c

Parameters:

string - to wrap

Method Detail

join

public final java.lang.String join(java.lang.Iterable<?> parts)

join

public final java.lang.String join(java.util.Iterator<?> parts)

join

public final java.lang.String join(java.lang.String... parts)
                            throws java.io.IOException

Throws:

java.io.IOException

get

public java.lang.String get(int index)

split

public list<java.lang.String> split(java.lang.String regex,
                                    int limit)

split

public list<java.lang.String> split()

stripAccents

public java.lang.String stripAccents()

translit

public java.lang.String translit()

unidecode

public java.lang.String unidecode()

count

public int count(java.lang.String substring)

count

public int count(char character)

upper

public java.lang.String upper()

lower

public java.lang.String lower()

strip

public java.lang.String strip()

strip

public java.lang.String strip(java.lang.String chars)

translate

public java.lang.String translate(list<tuple> fromTo)

title

public java.lang.String title()

capitalize

public java.lang.String capitalize()

in

public boolean in(java.lang.String... elements)

in

public boolean in(str str)

in

public boolean in(java.lang.Iterable<java.lang.String> iterable)

in

public boolean in(java.lang.String string)

notIn

public boolean notIn(java.lang.String... elements)

notIn

public boolean notIn(java.lang.Iterable<java.lang.String> iterable)

notIn

public boolean notIn(java.lang.String string)

notEquals

public boolean notEquals(java.lang.String string)

notEquals

public boolean notEquals(str str)

times

public java.lang.String times(int multiplier)

slice

public java.lang.String slice(int startIndex,
                              int endIndex)

slice

public java.lang.String slice(int startIndex,
                              int endIndex,
                              int step)

slice

public java.lang.String slice()

slice

public java.lang.String slice(int step)

sliceTo

public java.lang.String sliceTo(int endIndex,
                                int step)

sliceTo

public java.lang.String sliceTo(int endIndex)

sliceFrom

public java.lang.String sliceFrom(int startIndex,
                                  int step)

sliceFrom

public java.lang.String sliceFrom(int startIndex)

compress

public java.lang.String compress()

similarity

public double similarity(java.lang.String anotherString)

search

public int search(java.lang.String anotherString)

search

public double search(java.lang.String anotherString,
                     int approximateLocation)

search

public double search(java.lang.String anotherString,
                     int approximateLocation,
                     double threshold)

lookAlikes

public list<java.lang.String> lookAlikes(java.lang.Iterable<java.lang.String> candidates,
                                         double threshold)

lookAlikes

public list<java.lang.String> lookAlikes(java.lang.Iterable<java.lang.String> candidates)

parseJson

public <T> T parseJson()

Factory method that creates a new instance of xpresso base type (dict, list, etc) object from a valid Json object string representation. Example: JsonArray arr = x.Json("[[\"a\",\"b\",\"c\"],[\"d\",\"e\",\"f\"]]").parse();

Type Parameters:

T - output type

Returns:

an object of type T

length

public int length()

Returns the length of this string. The length is equal to the number of Unicode code units in the string.

Returns:

the length of the sequence of characters represented by this object.

isEmpty

public boolean isEmpty()

Returns true if, and only if, length() is 0.

Returns:

true if length() is 0, otherwise false

Since:

1.6

charAt

public char charAt(int index)

Returns the char value at the specified index. An index ranges from 0 to length() - 1. The first char value of the sequence is at index 0, the next at index 1, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters:

index - the index of the char value.

Returns:

the char value at the specified index of this string. The first char value is at index 0.

Throws:

java.lang.IndexOutOfBoundsException - if the index argument is negative or not less than the length of this string.

codePointAt

public int codePointAt(int index)

Returns the character (Unicode code point) at the specified index. The index refers to char values (Unicode code units) and ranges from 0 to length() - 1.

If the char value specified at the given index is in the high-surrogate range, the following index is less than the length of this String, and the char value at the following index is in the low-surrogate range, then the supplementary code point corresponding to this surrogate pair is returned. Otherwise, the char value at the given index is returned.

Parameters:

index - the index to the char values

Returns:

the code point value of the character at the index

Throws:

java.lang.IndexOutOfBoundsException - if the index argument is negative or not less than the length of this string.

Since:

1.5

codePointBefore

public int codePointBefore(int index)

Returns the character (Unicode code point) before the specified index. The index refers to char values (Unicode code units) and ranges from 1 to length.

If the char value at (index - 1) is in the low-surrogate range, (index - 2) is not negative, and the char value at (index - 2) is in the high-surrogate range, then the supplementary code point value of the surrogate pair is returned. If the char value at index - 1 is an unpaired low-surrogate or a high-surrogate, the surrogate value is returned.

Parameters:

index - the index following the code point that should be returned

Returns:

the Unicode code point value before the given index.

Throws:

java.lang.IndexOutOfBoundsException - if the index argument is less than 1 or greater than the length of this string.

Since:

1.5

codePointCount

public int codePointCount(int beginIndex,
                          int endIndex)

Returns the number of Unicode code points in the specified text range of this String. The text range begins at the specified beginIndex and extends to the char at index endIndex - 1. Thus the length (in chars) of the text range is endIndex-beginIndex. Unpaired surrogates within the text range count as one code point each.

Parameters:

beginIndex - the index to the first char of the text range.

endIndex - the index after the last char of the text range.

Returns:

the number of Unicode code points in the specified text range

Throws:

java.lang.IndexOutOfBoundsException - if the beginIndex is negative, or endIndex is larger than the length of this String, or beginIndex is larger than endIndex.

Since:

1.5

offsetByCodePoints

public int offsetByCodePoints(int index,
                              int codePointOffset)

Returns the index within this String that is offset from the given index by codePointOffset code points. Unpaired surrogates within the text range given by index and codePointOffset count as one code point each.

Parameters:

index - the index to be offset

codePointOffset - the offset in code points

Returns:

the index within this String

Throws:

java.lang.IndexOutOfBoundsException - if index is negative or larger then the length of this String, or if codePointOffset is positive and the substring starting with index has fewer than codePointOffset code points, or if codePointOffset is negative and the substring before index has fewer than the absolute value of codePointOffset code points.

Since:

1.5

getChars

public void getChars(int srcBegin,
                     int srcEnd,
                     char[] dst,
                     int dstBegin)

Copies characters from this string into the destination character array. The first character to be copied is at index srcBegin; the last character to be copied is at index srcEnd-1 (thus the total number of characters to be copied is srcEnd-srcBegin). The characters are copied into the subarray of dst starting at index dstBegin and ending at index:

      dstbegin + (srcEnd-srcBegin) - 1
 

Parameters:

srcBegin - index of the first character in the string to copy.

srcEnd - index after the last character in the string to copy.

dst - the destination array.

dstBegin - the start offset in the destination array.

Throws:

java.lang.IndexOutOfBoundsException - If any of the following is true:

• srcBegin is negative.
• srcBegin is greater than srcEnd
• srcEnd is greater than the length of this string
• dstBegin is negative
• dstBegin+(srcEnd-srcBegin) is larger than dst.length

getBytes

public byte[] getBytes(java.lang.String charsetName)
                throws java.io.UnsupportedEncodingException

Encodes this String into a sequence of bytes using the named charset, storing the result into a new byte array.

The behavior of this method when this string cannot be encoded in the given charset is unspecified. The CharsetEncoder class should be used when more control over the encoding process is required.

Parameters:

charsetName - The name of a supported charset

Returns:

The resultant byte array

Throws:

java.io.UnsupportedEncodingException - If the named charset is not supported

Since:

JDK1.1

getBytes

public byte[] getBytes(java.nio.charset.Charset charset)

Encodes this String into a sequence of bytes using the given charset, storing the result into a new byte array.

This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement byte array. The CharsetEncoder class should be used when more control over the encoding process is required.

Parameters:

charset - The Charset to be used to encode the String

Returns:

The resultant byte array

Since:

1.6

getBytes

public byte[] getBytes()

Encodes this String into a sequence of bytes using the platform's default charset, storing the result into a new byte array.

The behavior of this method when this string cannot be encoded in the default charset is unspecified. The CharsetEncoder class should be used when more control over the encoding process is required.

Returns:

The resultant byte array

Since:

JDK1.1

equals

public boolean equals(java.lang.Object anObject)

Compares this string to the specified object. The result is true if and only if the argument is not null and is a String object that represents the same sequence of characters as this object.

Overrides:

equals in class java.lang.Object

Parameters:

anObject - The object to compare this String against

Returns:

true if the given object represents a String equivalent to this string, false otherwise

See Also:

compareTo(String), equalsIgnoreCase(String)

contentEquals

public boolean contentEquals(java.lang.StringBuffer sb)

Compares this string to the specified StringBuffer. The result is true if and only if this String represents the same sequence of characters as the specified StringBuffer.

Parameters:

sb - The StringBuffer to compare this String against

Returns:

true if this String represents the same sequence of characters as the specified StringBuffer, false otherwise

Since:

1.4

contentEquals

public boolean contentEquals(java.lang.CharSequence cs)

Compares this string to the specified CharSequence. The result is true if and only if this String represents the same sequence of char values as the specified sequence.

Parameters:

cs - The sequence to compare this String against

Returns:

true if this String represents the same sequence of char values as the specified sequence, false otherwise

Since:

1.5

equalsIgnoreCase

public boolean equalsIgnoreCase(java.lang.String anotherString)

Compares this String to another String, ignoring case considerations. Two strings are considered equal ignoring case if they are of the same length and corresponding characters in the two strings are equal ignoring case.

Two characters c1 and c2 are considered the same ignoring case if at least one of the following is true:

• The two characters are the same (as compared by the == operator)
• Applying the method Character.toUpperCase(char) to each character produces the same result
• Applying the method Character.toLowerCase(char) to each character produces the same result

Parameters:

anotherString - The String to compare this String against

Returns:

true if the argument is not null and it represents an equivalent String ignoring case; false otherwise

See Also:

equals(Object)

compareTo

public int compareTo(java.lang.String anotherString)

Compares two strings lexicographically. The comparison is based on the Unicode value of each character in the strings. The character sequence represented by this String object is compared lexicographically to the character sequence represented by the argument string. The result is a negative integer if this String object lexicographically precedes the argument string. The result is a positive integer if this String object lexicographically follows the argument string. The result is zero if the strings are equal; compareTo returns 0 exactly when the equals(Object) method would return true.

This is the definition of lexicographic ordering. If two strings are different, then either they have different characters at some index that is a valid index for both strings, or their lengths are different, or both. If they have different characters at one or more index positions, let k be the smallest such index; then the string whose character at position k has the smaller value, as determined by using the < operator, lexicographically precedes the other string. In this case, compareTo returns the difference of the two character values at position k in the two string -- that is, the value:

 this.charAt(k)-anotherString.charAt(k)
 

If there is no index position at which they differ, then the shorter string lexicographically precedes the longer string. In this case, compareTo returns the difference of the lengths of the strings -- that is, the value:

 this.length()-anotherString.length()
 

Parameters:

anotherString - the String to be compared.

Returns:

the value 0 if the argument string is equal to this string; a value less than 0 if this string is lexicographically less than the string argument; and a value greater than 0 if this string is lexicographically greater than the string argument.

compareToIgnoreCase

public int compareToIgnoreCase(java.lang.String str)

Compares two strings lexicographically, ignoring case differences. This method returns an integer whose sign is that of calling compareTo with normalized versions of the strings where case differences have been eliminated by calling Character.toLowerCase(Character.toUpperCase(character)) on each character.

Note that this method does not take locale into account, and will result in an unsatisfactory ordering for certain locales. The java.text package provides collators to allow locale-sensitive ordering.

Parameters:

str - the String to be compared.

Returns:

a negative integer, zero, or a positive integer as the specified String is greater than, equal to, or less than this String, ignoring case considerations.

Since:

1.2

See Also:

Collator.compare(String, String)

regionMatches

public boolean regionMatches(int toffset,
                             java.lang.String other,
                             int ooffset,
                             int len)

Tests if two string regions are equal.

A substring of this String object is compared to a substring of the argument other. The result is true if these substrings represent identical character sequences. The substring of this String object to be compared begins at index toffset and has length len. The substring of other to be compared begins at index ooffset and has length len. The result is false if and only if at least one of the following is true:

• toffset is negative.
• ooffset is negative.
• toffset+len is greater than the length of this String object.
• ooffset+len is greater than the length of the other argument.
• There is some nonnegative integer k less than len such that: this.charAt(toffset+k) != other.charAt(ooffset+k)

Parameters:

toffset - the starting offset of the subregion in this string.

other - the string argument.

ooffset - the starting offset of the subregion in the string argument.

len - the number of characters to compare.

Returns:

true if the specified subregion of this string exactly matches the specified subregion of the string argument; false otherwise.

regionMatches

public boolean regionMatches(boolean ignoreCase,
                             int toffset,
                             java.lang.String other,
                             int ooffset,
                             int len)

Tests if two string regions are equal.

A substring of this String object is compared to a substring of the argument other. The result is true if these substrings represent character sequences that are the same, ignoring case if and only if ignoreCase is true. The substring of this String object to be compared begins at index toffset and has length len. The substring of other to be compared begins at index ooffset and has length len. The result is false if and only if at least one of the following is true:

• toffset is negative.
• ooffset is negative.
• toffset+len is greater than the length of this String object.
• ooffset+len is greater than the length of the other argument.
• ignoreCase is false and there is some nonnegative integer k less than len such that:

   this.charAt(toffset+k) != other.charAt(ooffset+k)
   

• ignoreCase is true and there is some nonnegative integer k less than len such that:

   Character.toLowerCase(this.charAt(toffset+k)) !=
       Character.toLowerCase(other.charAt(ooffset+k))
   

  and:

   Character.toUpperCase(this.charAt(toffset+k)) !=
           Character.toUpperCase(other.charAt(ooffset+k))
   

Parameters:

ignoreCase - if true, ignore case when comparing characters.

toffset - the starting offset of the subregion in this string.

other - the string argument.

ooffset - the starting offset of the subregion in the string argument.

len - the number of characters to compare.

Returns:

true if the specified subregion of this string matches the specified subregion of the string argument; false otherwise. Whether the matching is exact or case insensitive depends on the ignoreCase argument.

startsWith

public boolean startsWith(java.lang.String prefix,
                          int toffset)

Tests if the substring of this string beginning at the specified index starts with the specified prefix.

Parameters:

prefix - the prefix.

toffset - where to begin looking in this string.

Returns:

true if the character sequence represented by the argument is a prefix of the substring of this object starting at index toffset; false otherwise. The result is false if toffset is negative or greater than the length of this String object; otherwise the result is the same as the result of the expression

          this.substring(toffset).startsWith(prefix)
          

startsWith

public boolean startsWith(java.lang.String prefix)

Tests if this string starts with the specified prefix.

Parameters:

prefix - the prefix.

Returns:

true if the character sequence represented by the argument is a prefix of the character sequence represented by this string; false otherwise. Note also that true will be returned if the argument is an empty string or is equal to this String object as determined by the equals(Object) method.

Since:

1. 0

endsWith

public boolean endsWith(java.lang.String suffix)

Tests if this string ends with the specified suffix.

Parameters:

suffix - the suffix.

Returns:

true if the character sequence represented by the argument is a suffix of the character sequence represented by this object; false otherwise. Note that the result will be true if the argument is the empty string or is equal to this String object as determined by the equals(Object) method.

hashCode

public int hashCode()

Returns a hash code for this string. The hash code for a String object is computed as

 s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]
 

using int arithmetic, where s[i] is the ith character of the string, n is the length of the string, and ^ indicates exponentiation. (The hash value of the empty string is zero.)

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

indexOf

public int indexOf(int ch)

Returns the index within this string of the first occurrence of the specified character. If a character with value ch occurs in the character sequence represented by this String object, then the index (in Unicode code units) of the first such occurrence is returned. For values of ch in the range from 0 to 0xFFFF (inclusive), this is the smallest value k such that:

 this.charAt(k) == ch
 

is true. For other values of ch, it is the smallest value k such that:

 this.codePointAt(k) == ch
 

is true. In either case, if no such character occurs in this string, then -1 is returned.

Parameters:

ch - a character (Unicode code point).

Returns:

the index of the first occurrence of the character in the character sequence represented by this object, or -1 if the character does not occur.

indexOf

public int indexOf(int ch,
                   int fromIndex)

Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.

If a character with value ch occurs in the character sequence represented by this String object at an index no smaller than fromIndex, then the index of the first such occurrence is returned. For values of ch in the range from 0 to 0xFFFF (inclusive), this is the smallest value k such that:

 (this.charAt(k) == ch)  && (k >= fromIndex)
 

is true. For other values of ch, it is the smallest value k such that:

 (this.codePointAt(k) == ch)  && (k >= fromIndex)
 

is true. In either case, if no such character occurs in this string at or after position fromIndex, then -1 is returned.

There is no restriction on the value of fromIndex. If it is negative, it has the same effect as if it were zero: this entire string may be searched. If it is greater than the length of this string, it has the same effect as if it were equal to the length of this string: -1 is returned.

All indices are specified in char values (Unicode code units).

Parameters:

ch - a character (Unicode code point).

fromIndex - the index to start the search from.

Returns:

the index of the first occurrence of the character in the character sequence represented by this object that is greater than or equal to fromIndex, or -1 if the character does not occur.

lastIndexOf

public int lastIndexOf(int ch)

Returns the index within this string of the last occurrence of the specified character. For values of ch in the range from 0 to 0xFFFF (inclusive), the index (in Unicode code units) returned is the largest value k such that:

 this.charAt(k) == ch
 

is true. For other values of ch, it is the largest value k such that:

 this.codePointAt(k) == ch
 

is true. In either case, if no such character occurs in this string, then -1 is returned. The String is searched backwards starting at the last character.

Parameters:

ch - a character (Unicode code point).

Returns:

the index of the last occurrence of the character in the character sequence represented by this object, or -1 if the character does not occur.

lastIndexOf

public int lastIndexOf(int ch,
                       int fromIndex)

Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index. For values of ch in the range from 0 to 0xFFFF (inclusive), the index returned is the largest value k such that:

 (this.charAt(k) == ch)  && (k <= fromIndex)
 

is true. For other values of ch, it is the largest value k such that:

 (this.codePointAt(k) == ch)  && (k <= fromIndex)
 

is true. In either case, if no such character occurs in this string at or before position fromIndex, then -1 is returned.

All indices are specified in char values (Unicode code units).

Parameters:

ch - a character (Unicode code point).

fromIndex - the index to start the search from. There is no restriction on the value of fromIndex. If it is greater than or equal to the length of this string, it has the same effect as if it were equal to one less than the length of this string: this entire string may be searched. If it is negative, it has the same effect as if it were -1: -1 is returned.

Returns:

the index of the last occurrence of the character in the character sequence represented by this object that is less than or equal to fromIndex, or -1 if the character does not occur before that point.

indexOf

public int indexOf(java.lang.String str)

Returns the index within this string of the first occurrence of the specified substring.

The returned index is the smallest value k for which:

 this.startsWith(str, k)
 

If no such value of k exists, then -1 is returned.

Parameters:

str - the substring to search for.

Returns:

the index of the first occurrence of the specified substring, or -1 if there is no such occurrence.

indexOf

public int indexOf(java.lang.String str,
                   int fromIndex)

Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.

The returned index is the smallest value k for which:

 k >= fromIndex  && this.startsWith(str, k)
 

If no such value of k exists, then -1 is returned.

Parameters:

str - the substring to search for.

fromIndex - the index from which to start the search.

Returns:

the index of the first occurrence of the specified substring, starting at the specified index, or -1 if there is no such occurrence.

lastIndexOf

public int lastIndexOf(java.lang.String str)

Returns the index within this string of the last occurrence of the specified substring. The last occurrence of the empty string "" is considered to occur at the index value this.length().

The returned index is the largest value k for which:

 this.startsWith(str, k)
 

If no such value of k exists, then -1 is returned.

Parameters:

str - the substring to search for.

Returns:

the index of the last occurrence of the specified substring, or -1 if there is no such occurrence.

lastIndexOf

public int lastIndexOf(java.lang.String str,
                       int fromIndex)

Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the specified index.

The returned index is the largest value k for which:

 k <= fromIndex  && this.startsWith(str, k)
 

If no such value of k exists, then -1 is returned.

Parameters:

str - the substring to search for.

fromIndex - the index to start the search from.

Returns:

the index of the last occurrence of the specified substring, searching backward from the specified index, or -1 if there is no such occurrence.

substring

public java.lang.String substring(int beginIndex)

Returns a new string that is a substring of this string. The substring begins with the character at the specified index and extends to the end of this string.

Examples:

 "unhappy".substring(2) returns "happy"
 "Harbison".substring(3) returns "bison"
 "emptiness".substring(9) returns "" (an empty string)
 

Parameters:

beginIndex - the beginning index, inclusive.

Returns:

the specified substring.

Throws:

java.lang.IndexOutOfBoundsException - if beginIndex is negative or larger than the length of this String object.

substring

public java.lang.String substring(int beginIndex,
                                  int endIndex)

Returns a new string that is a substring of this string. The substring begins at the specified beginIndex and extends to the character at index endIndex - 1. Thus the length of the substring is endIndex-beginIndex.

Examples:

 "hamburger".substring(4, 8) returns "urge"
 "smiles".substring(1, 5) returns "mile"
 

Parameters:

beginIndex - the beginning index, inclusive.

endIndex - the ending index, exclusive.

Returns:

the specified substring.

Throws:

java.lang.IndexOutOfBoundsException - if the beginIndex is negative, or endIndex is larger than the length of this String object, or beginIndex is larger than endIndex.

subSequence

public java.lang.CharSequence subSequence(int beginIndex,
                                          int endIndex)

Returns a new character sequence that is a subsequence of this sequence.

An invocation of this method of the form

 str.subSequence(begin, end)

behaves in exactly the same way as the invocation

 str.substring(begin, end)

This method is defined so that the String class can implement the CharSequence interface.

Parameters:

beginIndex - the begin index, inclusive.

endIndex - the end index, exclusive.

Returns:

the specified subsequence.

Throws:

java.lang.IndexOutOfBoundsException - if beginIndex or endIndex are negative, if endIndex is greater than length(), or if beginIndex is greater than startIndex

concat

public java.lang.String concat(java.lang.String str)

Concatenates the specified string to the end of this string.

If the length of the argument string is 0, then this String object is returned. Otherwise, a new String object is created, representing a character sequence that is the concatenation of the character sequence represented by this String object and the character sequence represented by the argument string.

Examples:

 "cares".concat("s") returns "caress"
 "to".concat("get").concat("her") returns "together"
 

Parameters:

str - the String that is concatenated to the end of this String.

Returns:

a string that represents the concatenation of this object's characters followed by the string argument's characters.

replace

public java.lang.String replace(char oldChar,
                                char newChar)

Returns a new string resulting from replacing all occurrences of oldChar in this string with newChar.

If the character oldChar does not occur in the character sequence represented by this String object, then a reference to this String object is returned. Otherwise, a new String object is created that represents a character sequence identical to the character sequence represented by this String object, except that every occurrence of oldChar is replaced by an occurrence of newChar.

Examples:

 "mesquite in your cellar".replace('e', 'o')
         returns "mosquito in your collar"
 "the war of baronets".replace('r', 'y')
         returns "the way of bayonets"
 "sparring with a purple porpoise".replace('p', 't')
         returns "starring with a turtle tortoise"
 "JonL".replace('q', 'x') returns "JonL" (no change)
 

Parameters:

oldChar - the old character.

newChar - the new character.

Returns:

a string derived from this string by replacing every occurrence of oldChar with newChar.

matches

public boolean matches(java.lang.String regex)

Tells whether or not this string matches the given regular expression.

An invocation of this method of the form str.matches(regex) yields exactly the same result as the expression

Pattern.matches(regex, str)

Parameters:

regex - the regular expression to which this string is to be matched

Returns:

true if, and only if, this string matches the given regular expression

Throws:

java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid

See Also:

Pattern

contains

public boolean contains(java.lang.CharSequence s)

Returns true if and only if this string contains the specified sequence of char values.

Parameters:

s - the sequence to search for

Returns:

true if this string contains s, false otherwise

Throws:

java.lang.NullPointerException - if s is null

Since:

1.5

replaceFirst

public java.lang.String replaceFirst(java.lang.String regex,
                                     java.lang.String replacement)

Replaces the first substring of this string that matches the given regular expression with the given replacement.

An invocation of this method of the form str.replaceFirst(regex, repl) yields exactly the same result as the expression

Pattern.compile(regex).matcher(str).replaceFirst(repl)

Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see Matcher.replaceFirst(java.lang.String). Use Matcher.quoteReplacement(java.lang.String) to suppress the special meaning of these characters, if desired.

Parameters:

regex - the regular expression to which this string is to be matched

replacement - the string to be substituted for the first match

Returns:

The resulting String

Throws:

java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid

See Also:

Pattern

replaceAll

public java.lang.String replaceAll(java.lang.String regex,
                                   java.lang.String replacement)

Replaces each substring of this string that matches the given regular expression with the given replacement.

An invocation of this method of the form str.replaceAll(regex, repl) yields exactly the same result as the expression

Pattern.compile(regex).matcher(str).replaceAll(repl)

Note that backslashes (\) and dollar signs ($) in the replacement string may cause the results to be different than if it were being treated as a literal replacement string; see Matcher.replaceAll. Use Matcher.quoteReplacement(java.lang.String) to suppress the special meaning of these characters, if desired.

Parameters:

regex - the regular expression to which this string is to be matched

replacement - the string to be substituted for each match

Returns:

The resulting String

Throws:

java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid

See Also:

Pattern

replace

public java.lang.String replace(java.lang.CharSequence target,
                                java.lang.CharSequence replacement)

Replaces each substring of this string that matches the literal target sequence with the specified literal replacement sequence. The replacement proceeds from the beginning of the string to the end, for example, replacing "aa" with "b" in the string "aaa" will result in "ba" rather than "ab".

Parameters:

target - The sequence of char values to be replaced

replacement - The replacement sequence of char values

Returns:

The resulting string

Throws:

java.lang.NullPointerException - if target or replacement is null.

Since:

1.5

split

public list<java.lang.String> split(Regex regex,
                                    int limit)

Splits this string around matches of the given regular expression.

The array returned by this method contains each substring of this string that is terminated by another substring that matches the given expression or is terminated by the end of the string. The substrings in the array are in the order in which they occur in this string. If the expression does not match any part of the input then the resulting array has just one element, namely this string.

The limit parameter controls the number of times the pattern is applied and therefore affects the length of the resulting array. If the limit n is greater than zero then the pattern will be applied at most n - 1 times, the array's length will be no greater than n, and the array's last entry will contain all input beyond the last matched delimiter. If n is non-positive then the pattern will be applied as many times as possible and the array can have any length. If n is zero then the pattern will be applied as many times as possible, the array can have any length, and trailing empty strings will be discarded.

The string "boo:and:foo", for example, yields the following results with these parameters:

Regex	Limit	Result
:	2	{ "boo", "and:foo" }
:	5	{ "boo", "and", "foo" }
:	-2	{ "boo", "and", "foo" }
o	5	{ "b", "", ":and:f", "", "" }
o	-2	{ "b", "", ":and:f", "", "" }
o	0	{ "b", "", ":and:f" }

An invocation of this method of the form str.split(regex, n) yields the same result as the expression

Pattern.compile(regex).split(str, n)

Parameters:

regex - the delimiting regular expression

limit - the result threshold, as described above

Returns:

the array of strings computed by splitting this string around matches of the given regular expression

Throws:

java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid

See Also:

Pattern

split

public list<java.lang.String> split(java.lang.String regex)

Splits this string around matches of the given regular expression.

This method works as if by invoking the two-argument split method with the given expression and a limit argument of zero. Trailing empty strings are therefore not included in the resulting array.

The string "boo:and:foo", for example, yields the following results with these expressions:

Regex	Result
:	{ "boo", "and", "foo" }
o	{ "b", "", ":and:f" }

Parameters:

regex - the delimiting regular expression

Returns:

the array of strings computed by splitting this string around matches of the given regular expression

Throws:

java.util.regex.PatternSyntaxException - if the regular expression's syntax is invalid

See Also:

Pattern

toLowerCase

public java.lang.String toLowerCase(java.util.Locale locale)

Converts all of the characters in this String to lower case using the rules of the given Locale. Case mapping is based on the Unicode Standard version specified by the Character class. Since case mappings are not always 1:1 char mappings, the resulting String may be a different length than the original String.

Examples of lowercase mappings are in the following table:

Language Code of Locale	Upper Case	Lower Case	Description
tr (Turkish)	\u0130	\u0069	capital letter I with dot above -> small letter i
tr (Turkish)	\u0049	\u0131	capital letter I -> small letter dotless i
(all)	French Fries	french fries	lowercased all chars in String
(all)			lowercased all chars in String

Parameters:

locale - use the case transformation rules for this locale

Returns:

the String, converted to lowercase.

Since:

1.1

See Also:

String.toLowerCase(), String.toUpperCase(), String.toUpperCase(Locale)

toLowerCase

public java.lang.String toLowerCase()

Converts all of the characters in this String to lower case using the rules of the default locale. This is equivalent to calling toLowerCase(Locale.getDefault()).

Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "TITLE".toLowerCase() in a Turkish locale returns "t\u0131tle", where '\u0131' is the LATIN SMALL LETTER DOTLESS I character. To obtain correct results for locale insensitive strings, use toLowerCase(Locale.ENGLISH).

Returns:

the String, converted to lowercase.

See Also:

String.toLowerCase(Locale)

toUpperCase

public java.lang.String toUpperCase(java.util.Locale locale)

Converts all of the characters in this String to upper case using the rules of the given Locale. Case mapping is based on the Unicode Standard version specified by the Character class. Since case mappings are not always 1:1 char mappings, the resulting String may be a different length than the original String.

Examples of locale-sensitive and 1:M case mappings are in the following table.

Language Code of Locale	Lower Case	Upper Case	Description
tr (Turkish)	\u0069	\u0130	small letter i -> capital letter I with dot above
tr (Turkish)	\u0131	\u0049	small letter dotless i -> capital letter I
(all)	\u00df	\u0053 \u0053	small letter sharp s -> two letters: SS
(all)	Fahrvergnügen	FAHRVERGNÜGEN

Parameters:

locale - use the case transformation rules for this locale

Returns:

the String, converted to uppercase.

Since:

1.1

See Also:

String.toUpperCase(), String.toLowerCase(), String.toLowerCase(Locale)

toUpperCase

public java.lang.String toUpperCase()

Converts all of the characters in this String to upper case using the rules of the default locale. This method is equivalent to toUpperCase(Locale.getDefault()).

Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "title".toUpperCase() in a Turkish locale returns "T\u0130TLE", where '\u0130' is the LATIN CAPITAL LETTER I WITH DOT ABOVE character. To obtain correct results for locale insensitive strings, use toUpperCase(Locale.ENGLISH).

Returns:

the String, converted to uppercase.

See Also:

String.toUpperCase(Locale)

trim

public java.lang.String trim()

Returns a copy of the string, with leading and trailing whitespace omitted.

If this String object represents an empty character sequence, or the first and last characters of character sequence represented by this String object both have codes greater than '\u0020' (the space character), then a reference to this String object is returned.

Otherwise, if there is no character with a code greater than '\u0020' in the string, then a new String object representing an empty string is created and returned.

Otherwise, let k be the index of the first character in the string whose code is greater than '\u0020', and let m be the index of the last character in the string whose code is greater than '\u0020'. A new String object is created, representing the substring of this string that begins with the character at index k and ends with the character at index m-that is, the result of this.substring(k, m+1).

This method may be used to trim whitespace (as defined above) from the beginning and end of a string.

Returns:

A copy of this string with leading and trailing white space removed, or this string if it has no leading or trailing white space.

toString

public java.lang.String toString()

This object (which is already a string!) is itself returned.

Overrides:

toString in class java.lang.Object

Returns:

the string itself.

toCharArray

public char[] toCharArray()

Converts this string to a new character array.

Returns:

a newly allocated character array whose length is the length of this string and whose contents are initialized to contain the character sequence represented by this string.