com.robopupu.api.util

Class StringToolkit

java.lang.Object

com.robopupu.api.util.StringToolkit

public class StringToolkit
extends java.lang.Object

StringToolkit provides a set of convenience methods and utilities for using and modifying Strings.

Constructor Summary

Constructors

Constructor and Description
StringToolkit()

Method Summary

Modifier and Type	Method and Description
static boolean	containsOnlyWhitespaces(char[] chars, int start, int length) Tests if the given char array contains only whitespaces
static boolean	containsOnlyWhitespaces(java.lang.String string, int start, int length) Tests if the given String contains only whitespaces.
static java.lang.String	createValidIdentifier(java.lang.String string) Creates a valid identifier string from the given String.
static java.lang.String	createValidIdentifier(java.lang.String string, char replaceChar) Creates a valid identifier string from the given String where white spaces and other invalid identifier characters are replaced with the given replacement character.
static java.lang.String	encode(java.lang.String string) Encodes the given String using the default encoding.
static java.lang.String	encode(java.lang.String string, java.nio.charset.Charset encoding) Encodes the given String using the specified encoding.
static java.lang.String	encodeFileName(java.lang.String fileName)
static boolean	equals(char[] chars, int offset, int length, java.lang.String string) Tests if the given char array equals with the given String.
static boolean	equals(char[] chars, int length, java.lang.String string) Tests if the given char array equals with the given String.
static java.lang.String	formatString(android.content.res.Resources resources, int stringResId, int... formatArgResIds)
static java.lang.String	formatString(java.lang.String string, java.util.List<?> args) Formats the given String with given arguments.
static java.lang.String	formatString(java.lang.String string, java.lang.Object... args) Formats the given String with given arguments and by using the String.format(java.lang.String, java.lang.Object...) method.
static boolean	isBlank(java.lang.CharSequence string) Test if the given CharSequence is not null, but empty, or contains just white space.
static boolean	isEmpty(java.lang.String string) Test if the given String is either null, empty, or contains just white space
static boolean	isNotEmpty(java.lang.String string) Test if the given String is not null, empty, nor contains just white space
static boolean	isValidFileName(java.lang.String fileName) Tests whether the given String represents a valid file name.
static boolean	isValidIdentifier(java.lang.String identifier) Tests whether the given String represents a syntactically valid Java identifier.
static boolean	isValidNamespace(java.lang.String string) Tests whether the given String represents a syntactically valid namespace name.
static java.lang.String	lowerCaseFirstCharacter(java.lang.String string) Changes the first character of the given String to be a lowercase character.
static java.lang.String	normalize(java.lang.String string)
static java.lang.String	normalize(java.lang.String string, java.text.Normalizer.Form form)
static java.lang.String[]	parseKeyTokens(java.lang.String propertyKey) Parses the property key to create an array of Strings containing individual tokens of the key.
static void	parseKeyTokens(java.lang.String tokensString, java.lang.String separator, java.util.List<java.lang.String> tokens) Parses the tokens separated by the specified separator from the given String.
static java.lang.String	reverse(java.lang.String string) Reverses the given String.
static java.lang.String	stripWhiteSpaces(java.lang.String string) Strips all the white spaces from the given String.
static java.lang.String	truncateAt(java.lang.String string, int length) Truncates the given String to specified length.
static java.lang.String	upperCaseFirstCharacter(java.lang.String string) Changes the first character of the given String to be a uppercase character.
static java.lang.String	valueOrDefault(java.lang.String string, java.lang.String alternativeString) Return the given String as value if it is not empty as tested by isNotEmpty(String) or the given default value.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringToolkit

public StringToolkit()

Method Detail

createValidIdentifier

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

Creates a valid identifier string from the given String.

Parameters:

string - The object name as a String.

Returns:

The valid identifier as a String.

Throws:

java.lang.IllegalArgumentException - If the given string is null.

createValidIdentifier

public static java.lang.String createValidIdentifier(java.lang.String string,
                                                     char replaceChar)

Creates a valid identifier string from the given String where white spaces and other invalid identifier characters are replaced with the given replacement character.

Parameters:

string - The object name as a String.

replaceChar - A replace char.

Returns:

The valid identifier as a String.

Throws:

java.lang.IllegalArgumentException - If the given string is null.

containsOnlyWhitespaces

public static boolean containsOnlyWhitespaces(java.lang.String string,
                                              int start,
                                              int length)

Tests if the given String contains only whitespaces. If the String is null, boolean value true is returned.

Parameters:

string - The String to be tested.

start - The start offset.

length - The length of data.

Returns:

A boolean value.

containsOnlyWhitespaces

public static boolean containsOnlyWhitespaces(char[] chars,
                                              int start,
                                              int length)

Tests if the given char array contains only whitespaces

Parameters:

chars - The array of chars.

start - The start offset.

length - The length of data.

Returns:

A boolean value.

equals

public static boolean equals(char[] chars,
                             int length,
                             java.lang.String string)

Tests if the given char array equals with the given String.

Parameters:

chars - The given char array.

length - The number of characters to be compared. Should not exceed the length of the char array.

string - The given String. Cannot be null.

Returns:

A boolean value true if the char array and the String contain the same characters.

equals

public static boolean equals(char[] chars,
                             int offset,
                             int length,
                             java.lang.String string)

Tests if the given char array equals with the given String.

Parameters:

chars - The given char array.

offset - The offset for the char array.

length - The number of characters to be compared. Should not exceed the length of the char array.

string - The given String. Cannot be null.

Returns:

true if the char array and the String contain the same characters.

isValidIdentifier

public static boolean isValidIdentifier(java.lang.String identifier)

Tests whether the given String represents a syntactically valid Java identifier.

Parameters:

identifier - The given String to be tested.

Returns:

A boolean.

isValidFileName

public static boolean isValidFileName(java.lang.String fileName)

Tests whether the given String represents a valid file name.

Parameters:

fileName - The given String to be tested.

Returns:

A boolean.

isValidNamespace

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

Tests whether the given String represents a syntactically valid namespace name.

Parameters:

string - The given String to be tested.

Returns:

A boolean.

normalize

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

normalize

public static java.lang.String normalize(java.lang.String string,
                                         java.text.Normalizer.Form form)

encodeFileName

public static java.lang.String encodeFileName(java.lang.String fileName)

formatString

public static java.lang.String formatString(java.lang.String string,
                                            java.util.List<?> args)

Formats the given String with given arguments.

Parameters:

string - The string String.

args - A List containing the arguments for String.format(java.lang.String, java.lang.Object...) method.

Returns:

A formatted string String.

formatString

public static java.lang.String formatString(java.lang.String string,
                                            java.lang.Object... args)

Formats the given String with given arguments and by using the String.format(java.lang.String, java.lang.Object...) method.

Parameters:

string - The string String.

args - The arguments for String.format(java.lang.String, java.lang.Object...) method.

Returns:

A formatted string String.

formatString

public static java.lang.String formatString(android.content.res.Resources resources,
                                            int stringResId,
                                            int... formatArgResIds)

lowerCaseFirstCharacter

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

Changes the first character of the given String to be a lowercase character.

Parameters:

string - The given String. It must contain at least one character.

Returns:

The modified String.

parseKeyTokens

public static java.lang.String[] parseKeyTokens(java.lang.String propertyKey)

Parses the property key to create an array of Strings containing individual tokens of the key.

Parameters:

propertyKey - The specified property key String.

Returns:

An array of Strings containing the key tokens.

parseKeyTokens

public static void parseKeyTokens(java.lang.String tokensString,
                                  java.lang.String separator,
                                  java.util.List<java.lang.String> tokens)

Parses the tokens separated by the specified separator from the given String. Parsed tokens are stored into the given Vector.

Parameters:

tokensString - The given tokens String.

separator - The specified separator String.

tokens - A List used for storing the parsed tokens.

stripWhiteSpaces

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

Strips all the white spaces from the given String.

Parameters:

string - The given String.

Returns:

A String.

upperCaseFirstCharacter

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

Changes the first character of the given String to be a uppercase character.

Parameters:

string - The given String. It must contain at least one character.

Returns:

The modified String.

isBlank

public static boolean isBlank(java.lang.CharSequence string)

Test if the given CharSequence is not null, but empty, or contains just white space.

Parameters:

string - A CharSequence to be tested.

Returns:

A boolean.

valueOrDefault

public static java.lang.String valueOrDefault(java.lang.String string,
                                              java.lang.String alternativeString)

Return the given String as value if it is not empty as tested by isNotEmpty(String) or the given default value.

Parameters:

string - A String

alternativeString - A alternative value as a String.

Returns:

The selected String value.

truncateAt

public static java.lang.String truncateAt(java.lang.String string,
                                          int length)

Truncates the given String to specified length.

Parameters:

string - A String to be truncated.

length - The length of truncated String.

Returns:

The truncated String.

reverse

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

Reverses the given String.

Parameters:

string - A String to be reversed.

Returns:

The reversed String.

encode

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

Encodes the given String using the default encoding.

Parameters:

string - A String to be encoded.

Returns:

The encoded String.

encode

public static java.lang.String encode(java.lang.String string,
                                      java.nio.charset.Charset encoding)

Encodes the given String using the specified encoding.

Parameters:

string - A String to be encoded.

encoding - A Charset specifying the encoding.

Returns:

The encoded String.

isEmpty

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

Test if the given String is either null, empty, or contains just white space

Parameters:

string - A String to be tested.

Returns:

A boolean.

isNotEmpty

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

Test if the given String is not null, empty, nor contains just white space

Parameters:

string - A String to be tested.

Returns:

A boolean.