com.whitestein.lsps.stdlib.function

Class StringFunctions

java.lang.Object

com.whitestein.lsps.stdlib.function.StringFunctions

public class StringFunctions
extends Object

String related utility methods

Author:

rki

Constructor Summary

Constructors

Constructor and Description
StringFunctions()

Method Summary

Modifier and Type	Method and Description
ListHolder	find(ExecutionContext ctx, String string, String patternStr) Finds all occurrences of the regexp in the specified string.
String	format(ExecutionContext ctx, String pattern, Object... arguments) Returns a formatted string using the specified format string and arguments.
String	formatWithLocale(ExecutionContext ctx, String pattern, String locale, Object... arguments) Returns a formatted string using the specified format string and arguments.
Decimal	indexOf(ExecutionContext ctx, String string, String substring) Returns the index of the first occurrence of the specified substring within the string.
Decimal	indexOf(ExecutionContext ctx, String string, String substring, Decimal fromIndex) Returns the index of the first occurrence of the specified substring within the string, starting at the specified index.
boolean	isBlank(ExecutionContext ctx, String string) Return true if the string is either null or only consists of whitespaces.
boolean	isEmpty(ExecutionContext ctx, String string) Returns true if the string is either null or has zero length (contains no characters).
Decimal	lastIndexOf(ExecutionContext ctx, String string, String substring) Returns the index of the rightmost occurrence of the specified substring within the string.
Decimal	lastIndexOf(ExecutionContext ctx, String string, String substring, Decimal fromIndex) Returns the index of the last occurrence of the specified substring within the string, searching backward starting at the specified index.
Decimal	length(ExecutionContext ctx, String string) Returns the length of String
String	localize(ExecutionContext ctx, String string, String language) Returns the original string with all localizable strings replaced by their translation.
boolean	matches(ExecutionContext ctx, String string, String regexp) Check method to find out if given string matches regex
String	replaceAll(ExecutionContext ctx, String string, String regexp, String replacement) Replaces each substring of the string parameter that matches the regular expression given by the regexp parameter with the string specified as the replacement parameter.
String	replaceFirst(ExecutionContext ctx, String string, String regexp, String replacement) Replaces the first substring of the string that matches the regular expression given by the regexp parameter with the string specified as the replacement parameter.
ListHolder	split(ExecutionContext ctx, String string, String regexp) Splits the string around matches of regular expression given by the regexp parameter.
ListHolder	splitPathname(ExecutionContext ctx, String name) Splits a fully specified element name to names of it components which are separated by the namespace separator (::).
String	substring(ExecutionContext ctx, String string, Decimal fromIndex, Decimal toIndex) Returns a substring of the string
Decimal	toDecimal(ExecutionContext ctx, String string) If possible, converts the string parameter to a decimal value.
Decimal	toInteger(ExecutionContext ctx, String string) Converts String value using 10 radix to long
Decimal	toInteger(ExecutionContext ctx, String string, Decimal radix) Converts a given string value to integer using a given radix.
String	toLowerCase(ExecutionContext ctx, String string) Converts all characters of the specified string to lower case.
String	toLString(String moduleHash, String identifier, String... arguments) Deprecated. usage of this function was replaced by LocalizationOperation
String	toString(ExecutionContext ctx, Object object) Converts object to String using Object.toString() method
String	toString(ExecutionContext ctx, Object object, Boolean expandRecords) Converts object to String using Object.toString() method.
String	toUpperCase(ExecutionContext ctx, String string) Converts all characters of the string to upper case.
String	trim(ExecutionContext ctx, String string) Returns a copy of the string, with leading and trailing white space omitted.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringFunctions

public StringFunctions()

Method Detail

length

public Decimal length(ExecutionContext ctx,
                      String string)
               throws ErrorException

Returns the length of String

Parameters:

ctx -

string -

Returns:

the length of the sequence of characters of string

Throws:

ErrorException

toInteger

public Decimal toInteger(ExecutionContext ctx,
                         String string)
                  throws ErrorException

Converts String value using 10 radix to long

Parameters:

ctx -

string -

Returns:

converted value

Throws:

ErrorException

toInteger

public Decimal toInteger(ExecutionContext ctx,
                         String string,
                         Decimal radix)
                  throws ErrorException

Converts a given string value to integer using a given radix.

Parameters:

ctx -

string -

radix -

Returns:

converted value

Throws:

ErrorException

toDecimal

public Decimal toDecimal(ExecutionContext ctx,
                         String string)
                  throws ErrorException

If possible, converts the string parameter to a decimal value. If not possible, the function returns a runtime exception.

Parameters:

ctx -

string -

Returns:

converted value

Throws:

ErrorException

toString

public String toString(ExecutionContext ctx,
                       Object object)

Converts object to String using Object.toString() method

Parameters:

ctx -

object -

Returns:

Object.toString() result

toString

public String toString(ExecutionContext ctx,
                       Object object,
                       Boolean expandRecords)

Converts object to String using Object.toString() method. If object is instance of ValueHolder, it will use ToStringBuilder.toString(Object,boolean)

Parameters:

ctx -

object -

expandRecords -

Returns:

Object.toString() result

matches

public boolean matches(ExecutionContext ctx,
                       String string,
                       String regexp)
                throws ErrorException

Check method to find out if given string matches regex

Parameters:

ctx -

regexp - - pattern expression

string - - value

Returns:

true if given string matches pattern , otherwise false

Throws:

ErrorException

toLString

@Deprecated
public String toLString(String moduleHash,
                                    String identifier,
                                    String... arguments)

Deprecated. usage of this function was replaced by LocalizationOperation

Returns localized string for given function identifier and parameters

Parameters:

moduleHash -

identifier -

arguments -

Returns:

localized string for given function identifier and parameters

format

public String format(ExecutionContext ctx,
                     String pattern,
                     Object... arguments)
              throws ErrorException

Returns a formatted string using the specified format string and arguments. The java syntax of the format string (as defined in the java. util.Formatter class) is used.

Parameters:

ctx -

pattern -

arguments -

Returns:

a formatted string using the specified format string and arguments

Throws:

ErrorException

formatWithLocale

public String formatWithLocale(ExecutionContext ctx,
                               String pattern,
                               String locale,
                               Object... arguments)
                        throws ErrorException

Returns a formatted string using the specified format string and arguments. The java syntax of the format string (as defined in the java. util.Formatter class) is used. The locale parameter determines a locale used for formatting numbers and dates. If it is null, the server locale is used.

Parameters:

ctx -

pattern -

locale -

arguments -

Returns:

a formatted string using the specified format string and arguments

Throws:

ErrorException

replaceAll

public String replaceAll(ExecutionContext ctx,
                         String string,
                         String regexp,
                         String replacement)
                  throws ErrorException

Replaces each substring of the string parameter that matches the regular expression given by the regexp parameter with the string specified as the replacement parameter. The Java regular expression syntax (as defined in the Pattern class) is used.

Parameters:

ctx -

string -

regexp -

replacement -

Returns:

each substring of the string that matches the given regexp (regular expression) with the given replacement

Throws:

ErrorException

replaceFirst

public String replaceFirst(ExecutionContext ctx,
                           String string,
                           String regexp,
                           String replacement)
                    throws ErrorException

Replaces the first substring of the string that matches the regular expression given by the regexp parameter with the string specified as the replacement parameter. The Java regular expression syntax (as defined in the Pattern class) is used.

Parameters:

ctx -

string -

regexp -

replacement -

Returns:

the first substring of the string that matches the regular expression given by the regexp parameter with the string specified as the replacement parameter

Throws:

ErrorException

split

public ListHolder split(ExecutionContext ctx,
                        String string,
                        String regexp)
                 throws ErrorException

Splits the string around matches of regular expression given by the regexp parameter. The Java regular expression syntax (as defined in the Pattern class) is used.

Parameters:

ctx -

string -

regexp -

Returns:

the string around matches of regular expression given by the regexp parameter.

Throws:

ErrorException

trim

public String trim(ExecutionContext ctx,
                   String string)
            throws ErrorException

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

Parameters:

ctx -

string -

Returns:

a copy of the string, with leading and trailing white space omitted

Throws:

ErrorException

isEmpty

public boolean isEmpty(ExecutionContext ctx,
                       String string)
                throws ErrorException

Returns true if the string is either null or has zero length (contains no characters).

Parameters:

ctx -

string -

Returns:

true if the string is either null or has zero length (contains no characters)

Throws:

ErrorException

isBlank

public boolean isBlank(ExecutionContext ctx,
                       String string)
                throws ErrorException

Return true if the string is either null or only consists of whitespaces.

Parameters:

ctx -

string -

Returns:

true if the string is either null or only consists of whitespaces

Throws:

ErrorException

substring

public String substring(ExecutionContext ctx,
                        String string,
                        Decimal fromIndex,
                        Decimal toIndex)
                 throws ErrorException

Returns a substring of the string

Parameters:

ctx -

string -

fromIndex -

toIndex -

Returns:

substring of the string

Throws:

ErrorException

localize

public String localize(ExecutionContext ctx,
                       String string,
                       String language)
                throws ErrorException

Returns the original string with all localizable strings replaced by their translation. If the translation for localizable string is not found it will not be localized.

Parameters:

ctx -

string - not localized string

language -

Returns:

localized string

Throws:

ErrorException

indexOf

public Decimal indexOf(ExecutionContext ctx,
                       String string,
                       String substring)
                throws ErrorException

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

Parameters:

ctx -

string -

substring -

Returns:

index of the first occurrence of the specified substring

Throws:

ErrorException

indexOf

public Decimal indexOf(ExecutionContext ctx,
                       String string,
                       String substring,
                       Decimal fromIndex)
                throws ErrorException

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

Parameters:

ctx -

string -

substring -

fromIndex -

Returns:

the index of the first occurrence of the specified substring

Throws:

ErrorException

lastIndexOf

public Decimal lastIndexOf(ExecutionContext ctx,
                           String string,
                           String substring)
                    throws ErrorException

Returns the index of the rightmost occurrence of the specified substring within the string.

Parameters:

ctx -

string -

substring -

Returns:

index of the rightmost occurrence of the specified substring

Throws:

ErrorException

lastIndexOf

public Decimal lastIndexOf(ExecutionContext ctx,
                           String string,
                           String substring,
                           Decimal fromIndex)
                    throws ErrorException

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

Parameters:

ctx -

string -

substring -

fromIndex -

Returns:

index of the last occurrence of the specified substring

Throws:

ErrorException

toUpperCase

public String toUpperCase(ExecutionContext ctx,
                          String string)
                   throws ErrorException

Converts all characters of the string to upper case.

Parameters:

ctx -

string -

Returns:

the string in upper case

Throws:

ErrorException

toLowerCase

public String toLowerCase(ExecutionContext ctx,
                          String string)
                   throws ErrorException

Converts all characters of the specified string to lower case.

Parameters:

ctx -

string -

Returns:

the string in lower case

Throws:

ErrorException

find

public ListHolder find(ExecutionContext ctx,
                       String string,
                       String patternStr)
                throws ErrorException

Finds all occurrences of the regexp in the specified string. All the matched strings are returned as a list of strings. The function returns an empty list if there is no match. The Java regular expression syntax (as defined in the java.util.regex.Pattern class) is used.

Parameters:

ctx -

string -

patternStr -

Returns:

occurrences of the regexp in the specified string

Throws:

ErrorException

splitPathname

public ListHolder splitPathname(ExecutionContext ctx,
                                String name)
                         throws ErrorException

Splits a fully specified element name to names of it components which are separated by the namespace separator (::). For instance, splitPathname("module::'role 1'") results in ["module", "role 1"].

Parameters:

ctx -

name -

Returns:

the list of path segments

Throws:

ErrorException