cz.ues.platform.essentials.lang

Class StringFormatter

java.lang.Object

cz.ues.platform.essentials.lang.StringFormatter

public final class StringFormatter
extends java.lang.Object

StringFormatter.

Since:

UES6-00

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StringFormatter() StringFormatter is utility class and will be never instantiated.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	format(java.lang.String aMsg, java.lang.Object... aParams) The same behavior as MessageFormat.format(String, Object...) but supports better formatting of some types, like Arrays in parameters.
private static java.lang.Object[]	formatArrays(java.lang.Object... aParams) The java does not support pretty print on array in toString method.
private static boolean	isControlCharacter(int codePoint, int... allowedCodePoints) Determines control character.
static java.lang.String	removeControlCharacters(java.lang.String value, int... allowedCodePoints) Removes control characters from the given string value.
private static java.lang.String	transformMessage(java.lang.String message) Message containing { and } without formatting tag inside causes failure when formating message using MessageFormat.format.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringFormatter

private StringFormatter()

StringFormatter is utility class and will be never instantiated.

Since:

UES6-00

Method Detail

format

public static java.lang.String format(java.lang.String aMsg,
java.lang.Object... aParams)

The same behavior as MessageFormat.format(String, Object...) but supports better formatting of some types, like Arrays in parameters.

Parameters:

aMsg - The message to be formated and filled with parameters.

aParams - The parameters to be added to message.

Returns:

The formated String

Since:

UES6-00

See Also:

Formatter

removeControlCharacters

public static java.lang.String removeControlCharacters(java.lang.String value,
int... allowedCodePoints)

Removes control characters from the given string value. If there is no exception for some control character set via parameter allowedCodePoints all control characters will be removed.

Note: The control characters are determined via method Character.isISOControl(int).

Usage: remove all control characters except CR (0x0D) and LF (0x0A):

StringUtils.removeControlCharacters("some string value", 0x0A, 0x0D);

Parameters:

value - Value which can contain some control characters.

allowedCodePoints - This parameter determines which control characters should be retain in the returned string value.

Returns:

Value without control characters (except control characters specified in the parameter allowedControlCharacters).

Since:

UES7-10

isControlCharacter

private static boolean isControlCharacter(int codePoint,
int... allowedCodePoints)

Determines control character.

Parameters:

codePoint - Code point of tested character value.

allowedCodePoints - Array of code points which are taken as not-control characters.

Returns:

The value true if the specified code point represents a control character, the value false otherwise.

Since:

UES7-10

formatArrays

private static java.lang.Object[] formatArrays(java.lang.Object... aParams)

The java does not support pretty print on array in toString method. So this method transforms all arrays in parameters to pretty-printed String.

Parameters:

aParams - The parameters to be checked for Array type.

Returns:

The same parameters passed as parameter, but all arrays will be transformed to formated String representation.

Since:

UES6-00

transformMessage

private static java.lang.String transformMessage(java.lang.String message)

Message containing { and } without formatting tag inside causes failure when formating message using MessageFormat.format. This method replace such brackets with () brackets.

Parameters:

message - Original message

Returns:

Transformed message

Since:

UES7-10