com.gs.collections.impl.utility

Class StringIterate

java.lang.Object

com.gs.collections.impl.utility.StringIterate

public final class StringIterate
extends java.lang.Object

A string is essentially an array of characters. In Smalltalk a String is a subclass of ArrayedCollection, which means it supports the Collection protocol. StringIterate implements the methods available on the collection protocol that make sense for Strings. Some of the methods are over-specialized, in the form of englishToUppercase() which is a fast form of uppercase, but does not work for different locales.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	allSatisfy(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)
static boolean	allSatisfy(java.lang.String string, CodePointPredicate predicate)
static boolean	anySatisfy(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)
static boolean	anySatisfy(java.lang.String string, CodePointPredicate predicate)
static com.gs.collections.api.set.MutableSet<java.lang.Character>	asLowercaseSet(java.lang.String string) Deprecated. in 3.0. Inlineable.
static com.gs.collections.api.set.MutableSet<java.lang.Character>	asUppercaseSet(java.lang.String string) Deprecated. in 3.0. Inlineable.
static java.lang.String	collect(java.lang.String string, CharFunction function) Deprecated. since 3.0. Use collect(String, CharToCharFunction) instead.
static java.lang.String	collect(java.lang.String string, com.gs.collections.api.block.function.primitive.CharToCharFunction function)
static java.lang.String	collect(java.lang.String string, CodePointFunction function)
static int	count(java.lang.String string, CharPredicate predicate) Deprecated. since 3.0.
static int	count(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate) Count the number of elements that return true for the specified predicate.
static int	count(java.lang.String string, CodePointPredicate predicate) Count the number of elements that return true for the specified predicate.
static com.gs.collections.api.list.MutableList<java.lang.String>	csvTokensToList(java.lang.String string) Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.
static com.gs.collections.api.list.MutableList<java.lang.String>	csvTokensToReverseSortedList(java.lang.String string) Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.
static com.gs.collections.api.set.MutableSet<java.lang.String>	csvTokensToSet(java.lang.String string) Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.
static com.gs.collections.api.list.MutableList<java.lang.String>	csvTokensToSortedList(java.lang.String string) Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.
static com.gs.collections.api.list.MutableList<java.lang.String>	csvTrimmedTokensToList(java.lang.String string) Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.
static com.gs.collections.api.list.MutableList<java.lang.String>	csvTrimmedTokensToSortedList(java.lang.String string) Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.
static java.lang.Character	detect(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate) Find the first element that returns true for the specified predicate.
static java.lang.Character	detectIfNone(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate, char resultIfNone) Find the first element that returns true for the specified predicate.
static java.lang.Character	detectIfNone(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate, java.lang.String resultIfNone) Find the first element that returns true for the specified predicate.
static java.lang.String	englishToLowerCase(java.lang.String string)
static java.lang.String	englishToUpperCase(java.lang.String string)
static void	forEach(java.lang.String string, CharProcedure procedure) Deprecated. since 3.0. Use forEach(String, CharProcedure) instead.
static void	forEach(java.lang.String string, com.gs.collections.api.block.procedure.primitive.CharProcedure procedure) For each character in the string, execute the CharProcedure.
static void	forEach(java.lang.String string, CodePointProcedure procedure) For each character in the string, execute the CodePointProcedure.
static void	forEachToken(java.lang.String string, java.lang.String separator, com.gs.collections.api.block.procedure.Procedure<java.lang.String> procedure) For each token in a string separated by the specified separator, execute the specified StringProcedure by calling the valueOfString method.
static void	forEachTrimmedToken(java.lang.String string, java.lang.String separator, com.gs.collections.api.block.procedure.Procedure<java.lang.String> procedure) For each token in a string separated by the specified separator, execute the specified Procedure.
static java.lang.String	getFirstToken(java.lang.String value, java.lang.String separator)
static java.lang.String	getLastToken(java.lang.String value, java.lang.String separator)
static <T,R> R	injectIntoTokens(java.lang.String string, java.lang.String separator, R injectedValue, com.gs.collections.api.block.function.Function2<R,java.lang.String,R> function) For each token in a string separated by the specified separator, execute the specified Function2, returning the result value from the function.
static boolean	isAlphaNumeric(java.lang.String string)
static boolean	isEmpty(java.lang.String string)
static boolean	isEmptyOrWhitespace(java.lang.String string)
static boolean	isNumber(java.lang.String string)
static boolean	noneSatisfy(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)
static boolean	noneSatisfy(java.lang.String string, CodePointPredicate predicate)
static boolean	notEmpty(java.lang.String string)
static boolean	notEmptyOrWhitespace(java.lang.String string)
static int	occurrencesOf(java.lang.String string, char value) Count the number of occurrences of the specified char.
static int	occurrencesOf(java.lang.String string, int value) Count the number of occurrences of the specified code point.
static int	occurrencesOf(java.lang.String string, java.lang.String singleCharacter) Count the number of occurrences of the specified string.
static java.lang.String	padOrTrim(java.lang.String message, int targetLength)
static java.lang.String	reject(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)
static java.lang.String	reject(java.lang.String string, CodePointPredicate predicate)
static java.lang.String	repeat(char c, int repeatTimes)
static java.lang.String	repeat(java.lang.String template, int repeatTimes)
static void	reverseForEach(java.lang.String string, com.gs.collections.api.block.procedure.primitive.CharProcedure procedure) For each character in the string in reverse order, execute the CharProcedure.
static void	reverseForEach(java.lang.String string, CodePointProcedure procedure) For each character in the string in reverse order, execute the CodePointProcedure.
static java.lang.String	select(java.lang.String string, com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)
static java.lang.String	select(java.lang.String string, CodePointPredicate predicate)
static com.gs.collections.api.tuple.Twin<java.lang.String>	splitAtIndex(java.lang.String aString, int index)
static com.gs.collections.api.bag.MutableBag<java.lang.Character>	toBag(java.lang.String string)
static com.gs.collections.api.list.MutableList<java.lang.String>	tokensToList(java.lang.String string, java.lang.String separator) Converts a string of tokens separated by the specified separator to a MutableList.
static com.gs.collections.api.map.MutableMap<java.lang.String,java.lang.String>	tokensToMap(java.lang.String string) Converts a string of tokens to a MutableMap using a | to separate pairs, and a : to separate key and value.
static com.gs.collections.api.map.MutableMap<java.lang.String,java.lang.String>	tokensToMap(java.lang.String string, java.lang.String pairSeparator, java.lang.String keyValueSeparator) Converts a string of tokens to a MutableMap using the specified separators.
static <K,V> com.gs.collections.api.map.MutableMap<K,V>	tokensToMap(java.lang.String string, java.lang.String separator, java.lang.String keyValueSeparator, com.gs.collections.api.block.function.Function<java.lang.String,K> keyFunction, com.gs.collections.api.block.function.Function<java.lang.String,V> valueFunction) Converts a string of tokens to a MutableMap using the specified 'key' and 'value' Functions.
static com.gs.collections.api.list.MutableList<java.lang.String>	tokensToReverseSortedList(java.lang.String string, java.lang.String separator) Converts a string of tokens separated by the specified separator to a reverse sorted MutableList.
static com.gs.collections.api.set.MutableSet<java.lang.String>	tokensToSet(java.lang.String string, java.lang.String separator) Converts a string of tokens to a MutableSet.
static com.gs.collections.api.list.MutableList<java.lang.String>	tokensToSortedList(java.lang.String string, java.lang.String separator) Converts a string of tokens separated by the specified separator to a sorted MutableList.
static com.gs.collections.api.list.MutableList<java.lang.Character>	toList(java.lang.String string)
static com.gs.collections.api.bag.MutableBag<java.lang.Character>	toLowercaseBag(java.lang.String string)
static com.gs.collections.api.list.MutableList<java.lang.Character>	toLowercaseList(java.lang.String string)
static com.gs.collections.api.set.MutableSet<java.lang.Character>	toLowercaseSet(java.lang.String string)
static com.gs.collections.api.set.MutableSet<java.lang.Character>	toSet(java.lang.String string)
static com.gs.collections.api.bag.MutableBag<java.lang.Character>	toUppercaseBag(java.lang.String string)
static com.gs.collections.api.list.MutableList<java.lang.Character>	toUppercaseList(java.lang.String string)
static com.gs.collections.api.set.MutableSet<java.lang.Character>	toUppercaseSet(java.lang.String string)
static com.gs.collections.api.list.MutableList<java.lang.String>	trimmedTokensToList(java.lang.String string, java.lang.String separator) Converts a string of tokens separated by the specified separator to a MutableList.
static com.gs.collections.api.list.MutableList<java.lang.String>	trimmedTokensToSortedList(java.lang.String string, java.lang.String separator) Converts a string of tokens separated by the specified separator to a sorted MutableList.

Methods inherited from class java.lang.Object

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

Method Detail

csvTokensToSortedList

@Deprecated
public static com.gs.collections.api.list.MutableList<java.lang.String> csvTokensToSortedList(java.lang.String string)

Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.

Converts a string of tokens separated by the specified separator to a sorted MutableList.

csvTrimmedTokensToSortedList

@Deprecated
public static com.gs.collections.api.list.MutableList<java.lang.String> csvTrimmedTokensToSortedList(java.lang.String string)

Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.

Converts a string of tokens separated by the specified separator to a sorted MutableList.

tokensToSortedList

public static com.gs.collections.api.list.MutableList<java.lang.String> tokensToSortedList(java.lang.String string,
                                                                           java.lang.String separator)

Converts a string of tokens separated by the specified separator to a sorted MutableList.

trimmedTokensToSortedList

public static com.gs.collections.api.list.MutableList<java.lang.String> trimmedTokensToSortedList(java.lang.String string,
                                                                                  java.lang.String separator)

Converts a string of tokens separated by the specified separator to a sorted MutableList.

csvTokensToList

@Deprecated
public static com.gs.collections.api.list.MutableList<java.lang.String> csvTokensToList(java.lang.String string)

Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.

Converts a string of tokens separated by commas to a MutableList.

csvTrimmedTokensToList

@Deprecated
public static com.gs.collections.api.list.MutableList<java.lang.String> csvTrimmedTokensToList(java.lang.String string)

Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.

Converts a string of tokens separated by commas to a MutableList.

tokensToList

public static com.gs.collections.api.list.MutableList<java.lang.String> tokensToList(java.lang.String string,
                                                                     java.lang.String separator)

Converts a string of tokens separated by the specified separator to a MutableList.

trimmedTokensToList

public static com.gs.collections.api.list.MutableList<java.lang.String> trimmedTokensToList(java.lang.String string,
                                                                            java.lang.String separator)

Converts a string of tokens separated by the specified separator to a MutableList.

csvTokensToSet

@Deprecated
public static com.gs.collections.api.set.MutableSet<java.lang.String> csvTokensToSet(java.lang.String string)

Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.

Converts a string of tokens separated by commas to a MutableSet.

tokensToSet

public static com.gs.collections.api.set.MutableSet<java.lang.String> tokensToSet(java.lang.String string,
                                                                  java.lang.String separator)

Converts a string of tokens to a MutableSet.

tokensToMap

public static com.gs.collections.api.map.MutableMap<java.lang.String,java.lang.String> tokensToMap(java.lang.String string)

Converts a string of tokens to a MutableMap using a | to separate pairs, and a : to separate key and value. e.g. "1:Sunday|2:Monday|3:Tuesday|4:Wednesday|5:Thursday|6:Friday|7:Saturday"

tokensToMap

public static com.gs.collections.api.map.MutableMap<java.lang.String,java.lang.String> tokensToMap(java.lang.String string,
                                                                                   java.lang.String pairSeparator,
                                                                                   java.lang.String keyValueSeparator)

Converts a string of tokens to a MutableMap using the specified separators.

tokensToMap

public static <K,V> com.gs.collections.api.map.MutableMap<K,V> tokensToMap(java.lang.String string,
                                                           java.lang.String separator,
                                                           java.lang.String keyValueSeparator,
                                                           com.gs.collections.api.block.function.Function<java.lang.String,K> keyFunction,
                                                           com.gs.collections.api.block.function.Function<java.lang.String,V> valueFunction)

Converts a string of tokens to a MutableMap using the specified 'key' and 'value' Functions. e.g. "1:2,2:1,3:3" with both functions as Functions.getStringToInteger(), will be translated a map {[1,2],[2,1],[3,3]}

csvTokensToReverseSortedList

@Deprecated
public static com.gs.collections.api.list.MutableList<java.lang.String> csvTokensToReverseSortedList(java.lang.String string)

Deprecated. in 3.0. Inlineable. Poorly named method. Does not actually deal properly with CSV. This is better handled in a separate library.

Converts a string of tokens separated by the specified separator to a reverse sorted MutableList.

tokensToReverseSortedList

public static com.gs.collections.api.list.MutableList<java.lang.String> tokensToReverseSortedList(java.lang.String string,
                                                                                  java.lang.String separator)

Converts a string of tokens separated by the specified separator to a reverse sorted MutableList.

forEachToken

public static void forEachToken(java.lang.String string,
                java.lang.String separator,
                com.gs.collections.api.block.procedure.Procedure<java.lang.String> procedure)

For each token in a string separated by the specified separator, execute the specified StringProcedure by calling the valueOfString method.

injectIntoTokens

public static <T,R> R injectIntoTokens(java.lang.String string,
                       java.lang.String separator,
                       R injectedValue,
                       com.gs.collections.api.block.function.Function2<R,java.lang.String,R> function)

For each token in a string separated by the specified separator, execute the specified Function2, returning the result value from the function. For more information, see Iterate.injectInto(Object, Iterable, Function2)

forEachTrimmedToken

public static void forEachTrimmedToken(java.lang.String string,
                       java.lang.String separator,
                       com.gs.collections.api.block.procedure.Procedure<java.lang.String> procedure)

For each token in a string separated by the specified separator, execute the specified Procedure.

forEach

@Deprecated
public static void forEach(java.lang.String string,
                      CharProcedure procedure)

Deprecated. since 3.0. Use forEach(String, CharProcedure) instead.

For each character in the string, execute the CharProcedure.

forEach

public static void forEach(java.lang.String string,
           com.gs.collections.api.block.procedure.primitive.CharProcedure procedure)

For each character in the string, execute the CharProcedure.

forEach

public static void forEach(java.lang.String string,
           CodePointProcedure procedure)

For each character in the string, execute the CodePointProcedure.

reverseForEach

public static void reverseForEach(java.lang.String string,
                  com.gs.collections.api.block.procedure.primitive.CharProcedure procedure)

For each character in the string in reverse order, execute the CharProcedure.

reverseForEach

public static void reverseForEach(java.lang.String string,
                  CodePointProcedure procedure)

For each character in the string in reverse order, execute the CodePointProcedure.

count

@Deprecated
public static int count(java.lang.String string,
                   CharPredicate predicate)

Deprecated. since 3.0.

Count the number of elements that return true for the specified predicate.

count

public static int count(java.lang.String string,
        com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)

Count the number of elements that return true for the specified predicate.

count

public static int count(java.lang.String string,
        CodePointPredicate predicate)

Count the number of elements that return true for the specified predicate.

collect

@Deprecated
public static java.lang.String collect(java.lang.String string,
                                  CharFunction function)

Deprecated. since 3.0. Use collect(String, CharToCharFunction) instead.

collect

public static java.lang.String collect(java.lang.String string,
                       com.gs.collections.api.block.function.primitive.CharToCharFunction function)

collect

public static java.lang.String collect(java.lang.String string,
                       CodePointFunction function)

englishToUpperCase

public static java.lang.String englishToUpperCase(java.lang.String string)

englishToLowerCase

public static java.lang.String englishToLowerCase(java.lang.String string)

detect

public static java.lang.Character detect(java.lang.String string,
                         com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)

Find the first element that returns true for the specified predicate.

detectIfNone

public static java.lang.Character detectIfNone(java.lang.String string,
                               com.gs.collections.api.block.predicate.primitive.CharPredicate predicate,
                               char resultIfNone)

Find the first element that returns true for the specified predicate. Return the default char if no value is found.

detectIfNone

public static java.lang.Character detectIfNone(java.lang.String string,
                               com.gs.collections.api.block.predicate.primitive.CharPredicate predicate,
                               java.lang.String resultIfNone)

Find the first element that returns true for the specified predicate. Return the first char of the default string if no value is found.

occurrencesOf

public static int occurrencesOf(java.lang.String string,
                char value)

Count the number of occurrences of the specified char.

occurrencesOf

public static int occurrencesOf(java.lang.String string,
                int value)

Count the number of occurrences of the specified code point.

occurrencesOf

public static int occurrencesOf(java.lang.String string,
                java.lang.String singleCharacter)

Count the number of occurrences of the specified string.

anySatisfy

public static boolean anySatisfy(java.lang.String string,
                 com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)

Returns:

true if any of the characters in the string answer true for the specified predicate.

anySatisfy

public static boolean anySatisfy(java.lang.String string,
                 CodePointPredicate predicate)

Returns:

true if any of the code points in the string answer true for the specified predicate.

allSatisfy

public static boolean allSatisfy(java.lang.String string,
                 com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)

Returns:

true if all of the characters in the string answer true for the specified predicate.

allSatisfy

public static boolean allSatisfy(java.lang.String string,
                 CodePointPredicate predicate)

Returns:

true if all of the code points in the string answer true for the specified predicate.

noneSatisfy

public static boolean noneSatisfy(java.lang.String string,
                  com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)

Returns:

true if none of the characters in the string answer true for the specified predicate.

noneSatisfy

public static boolean noneSatisfy(java.lang.String string,
                  CodePointPredicate predicate)

Returns:

true if none of the code points in the string answer true for the specified predicate.

select

public static java.lang.String select(java.lang.String string,
                      com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)

Returns:

a new string with all of the characters that return true for the specified predicate.

select

public static java.lang.String select(java.lang.String string,
                      CodePointPredicate predicate)

Returns:

a new string with all of the code points that return true for the specified predicate.

reject

public static java.lang.String reject(java.lang.String string,
                      com.gs.collections.api.block.predicate.primitive.CharPredicate predicate)

Returns:

a new string excluding all of the characters that return true for the specified predicate.

reject

public static java.lang.String reject(java.lang.String string,
                      CodePointPredicate predicate)

Returns:

a new string excluding all of the code points that return true for the specified predicate.

getLastToken

public static java.lang.String getLastToken(java.lang.String value,
                            java.lang.String separator)

getFirstToken

public static java.lang.String getFirstToken(java.lang.String value,
                             java.lang.String separator)

isEmpty

public static boolean isEmpty(java.lang.String string)

isEmptyOrWhitespace

public static boolean isEmptyOrWhitespace(java.lang.String string)

isNumber

public static boolean isNumber(java.lang.String string)

isAlphaNumeric

public static boolean isAlphaNumeric(java.lang.String string)

notEmpty

public static boolean notEmpty(java.lang.String string)

notEmptyOrWhitespace

public static boolean notEmptyOrWhitespace(java.lang.String string)

repeat

public static java.lang.String repeat(java.lang.String template,
                      int repeatTimes)

repeat

public static java.lang.String repeat(char c,
                      int repeatTimes)

padOrTrim

public static java.lang.String padOrTrim(java.lang.String message,
                         int targetLength)

toList

public static com.gs.collections.api.list.MutableList<java.lang.Character> toList(java.lang.String string)

toLowercaseList

public static com.gs.collections.api.list.MutableList<java.lang.Character> toLowercaseList(java.lang.String string)

toUppercaseList

public static com.gs.collections.api.list.MutableList<java.lang.Character> toUppercaseList(java.lang.String string)

toBag

public static com.gs.collections.api.bag.MutableBag<java.lang.Character> toBag(java.lang.String string)

toLowercaseBag

public static com.gs.collections.api.bag.MutableBag<java.lang.Character> toLowercaseBag(java.lang.String string)

toUppercaseBag

public static com.gs.collections.api.bag.MutableBag<java.lang.Character> toUppercaseBag(java.lang.String string)

toSet

public static com.gs.collections.api.set.MutableSet<java.lang.Character> toSet(java.lang.String string)

asUppercaseSet

@Deprecated
public static com.gs.collections.api.set.MutableSet<java.lang.Character> asUppercaseSet(java.lang.String string)

Deprecated. in 3.0. Inlineable.

toUppercaseSet

public static com.gs.collections.api.set.MutableSet<java.lang.Character> toUppercaseSet(java.lang.String string)

asLowercaseSet

@Deprecated
public static com.gs.collections.api.set.MutableSet<java.lang.Character> asLowercaseSet(java.lang.String string)

Deprecated. in 3.0. Inlineable.

toLowercaseSet

public static com.gs.collections.api.set.MutableSet<java.lang.Character> toLowercaseSet(java.lang.String string)

splitAtIndex

public static com.gs.collections.api.tuple.Twin<java.lang.String> splitAtIndex(java.lang.String aString,
                                                               int index)