com.mgnt.utils

Class TextUtils

java.lang.Object

com.mgnt.utils.TextUtils

public class TextUtils
extends java.lang.Object

This class provides various utilities for work with String that represents some other type.

In current version this class provides methods for converting a String into its numeric value of various types (Integer, Float, Byte, Double, Long, Short).

There are several methods for retrieving Exception stacktrace as a String in full or shortened version. Shortened version of the stacktrace will contain concise information focusing on specific set of packages or subpackages while removing long parts of irrelevant stacktrace. This could be very useful for logging in web-based architecture where stacktrace may contain long parts of server provided classes trace that could be eliminated with the methods of this class while retaining important parts of the stacktrace relating to user's packages. Also the same utility (starting from version 1.5.0.3) allows to filter and shorten stacktrace as a string the same way as the stacktrace extracted from exception. So, essentially stacktraces could be filtered "on the fly" at run time or later on from any text source such as log.

Also this class provides methods that work with textual representation of versions. Valid version is a String of the following format:

X[.X[.X[...]]]

where X is a zero or positive integer not larger than 2147483647. Leading or trailing white spaces in this string are permitted and are ignored. Examples of valid versions are: "1.6", "58", " 7.34.17 " etc. (Note that last example contains both leading and trailing white spaces and it is still a valid version)

Another useful feature is parsing String to time interval. It parses Strings with numerical value and optional time unit suffix (for example string "38s" will be parsed as 38 seconds, "24m" - 24 minutes "4h" - 4 hours, "3d" - 3 days and "45" as 45 milliseconds.) This method may be very useful for parsing time interval properties such as timeouts or waiting periods from configuration files.

Also in this class there is a method that converts String to preserve indentation formatting for html without use of escape characters. It converts a String in such a way that its spaces are not modified by HTML renderer i.e. it replaces regular space characters with non-breaking spaces known as '&nbsp;' but they look in your source as regular space ' ' and not as '&nbsp;' It also replaces new line character with '<br>'.

Note that this class has a loose dependency on slf4J library. If in the project some other compatible logging library is present (such as Log4J) this class will still work without any ill effects

Author:

Michael Gantman

Constructor Summary

Constructors

Constructor and Description
TextUtils()

Method Summary

Modifier and Type	Method and Description
static int	compareVersions(java.lang.String ver1, java.lang.String ver2) This method compares 2 Strings as versions
static int	compareVersions(java.lang.String ver1, Version ver2) This method compares a String that represents a version to a Version
static int	compareVersions(Version ver1, java.lang.String ver2) This method compares a Version to a String that represents a version
static int	compareVersions(Version ver1, Version ver2) This method compares two Version instances
static java.lang.String	formatStringToPreserveIndentationForHtml(java.lang.String rawText) This method converts a String in such a way that its spaces are not modified by HTML renderer i.e.
static java.lang.String[]	getRelevantPackage() This a getter method for global value of relevant package prefix property
static java.lang.String	getStacktrace(java.lang.CharSequence stacktrace) This method retrieves a stacktrace in shortened format from source stacktrace provided as CharSequence.
static java.lang.String	getStacktrace(java.lang.CharSequence stacktrace, java.lang.String... relevantPackages) This method retrieves a stacktrace in shortened format from source stactrace provided as CharSequence.
static java.lang.String	getStacktrace(java.lang.Throwable e) This method retrieves a stacktrace from Throwable as a String in shortened format.
static java.lang.String	getStacktrace(java.lang.Throwable e, boolean cutTBS) This method retrieves a stacktrace from Throwable as a String in full or shortened format.
static java.lang.String	getStacktrace(java.lang.Throwable e, boolean cutTBS, java.lang.String... relevantPackages) This method retrieves a stacktrace from Throwable as a String in full or shortened format.
static java.lang.String	getStacktrace(java.lang.Throwable e, java.lang.String... relevantPackages) This method retrieves a stacktrace from Throwable as a String in shortened format.
static java.math.BigDecimal	parseStringToBigDecimal(java.lang.CharSequence num, java.math.BigDecimal defaultValue) This method parses a String to its BigDecimal value silently.
static java.math.BigDecimal	parseStringToBigDecimal(java.lang.CharSequence num, java.math.BigDecimal defaultValue, java.lang.String nullOrEmptyStringErrorMessage, java.lang.String numberFormatErrorMessage) This method parses a String to BigDecimal value.
static java.math.BigInteger	parseStringToBigInteger(java.lang.CharSequence num, java.math.BigInteger defaultValue) This method parses a String to its BigInteger value silently.
static java.math.BigInteger	parseStringToBigInteger(java.lang.CharSequence num, java.math.BigInteger defaultValue, java.lang.String nullOrEmptyStringErrorMessage, java.lang.String numberFormatErrorMessage) This method parses a String to BigInteger value.
static java.lang.Byte	parseStringToByte(java.lang.CharSequence num, byte defaultValue) This method parses a String to its Numeric value silently.
static java.lang.Byte	parseStringToByte(java.lang.CharSequence num, byte defaultValue, java.lang.String nullOrEmptyStringErrorMessage, java.lang.String numberFormatErrorMessage) This method parses a String to Numeric value.
static double	parseStringToDouble(java.lang.CharSequence num, double defaultValue) This method parses a String to its Numeric value silently.
static double	parseStringToDouble(java.lang.CharSequence num, double defaultValue, java.lang.String nullOrEmptyStringErrorMessage, java.lang.String numberFormatErrorMessage) This method parses a String to Numeric value.
static float	parseStringToFloat(java.lang.CharSequence num, float defaultValue) This method parses a String to its Numeric value silently.
static float	parseStringToFloat(java.lang.CharSequence num, float defaultValue, java.lang.String nullOrEmptyStringErrorMessage, java.lang.String numberFormatErrorMessage) This method parses a String to Numeric value.
static int	parseStringToInt(java.lang.CharSequence num, int defaultValue) This method parses a String to its Numeric value silently.
static int	parseStringToInt(java.lang.CharSequence num, int defaultValue, java.lang.String nullOrEmptyStringErrorMessage, java.lang.String numberFormatErrorMessage) This method parses a String to its Numeric value.
static long	parseStringToLong(java.lang.CharSequence num, long defaultValue) This method parses a String to its Numeric value silently.
static long	parseStringToLong(java.lang.CharSequence num, long defaultValue, java.lang.String nullOrEmptyStringErrorMessage, java.lang.String numberFormatErrorMessage) This method parses a String to Numeric value.
static java.lang.Short	parseStringToShort(java.lang.CharSequence num, short defaultValue) This method parses a String to its Numeric value silently.
static java.lang.Short	parseStringToShort(java.lang.CharSequence num, short defaultValue, java.lang.String nullOrEmptyStringErrorMessage, java.lang.String numberFormatErrorMessage) This method parses a String to Numeric value.
static TimeInterval	parseStringToTimeInterval(java.lang.String valueStr) This method parses String value into TimeInterval.
static TimeInterval	parsingStringToTimeInterval(java.lang.String valueStr) Deprecated. Use parseStringToTimeInterval(String) instead. The new method the same as this one except the name change. This method is left for backwards compatibility only and will be removed in future versions.
static void	setRelevantPackage(java.lang.String... relevantPackages) This is a setter method for relevant package prefix array property for method getStacktrace(Throwable, boolean) Once the value has been set the convenience method getStacktrace(Throwable, boolean) could be used instead of method getStacktrace(Throwable, boolean, String...)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextUtils

public TextUtils()

Method Detail

compareVersions

public static int compareVersions(java.lang.String ver1,
                                  java.lang.String ver2)
                           throws InvalidVersionFormatException

This method compares 2 Strings as versions

Parameters:

ver1 - String that contains version for comparison

ver2 - String that contains version for comparison

Returns:

negative integer (-1) if the first version is lesser then the second, 0 if the versions are equal and positive integer (1) if the first version is greater than second

Throws:

InvalidVersionFormatException - if any of the String instances is not a valid Version

compareVersions

public static int compareVersions(Version ver1,
                                  java.lang.String ver2)
                           throws InvalidVersionFormatException

This method compares a Version to a String that represents a version

Parameters:

ver1 - Version for comparison

ver2 - String that contains version for comparison

Returns:

negative integer (-1) if the first version is lesser then the second, 0 if the versions are equal and positive integer (1) if the first version is greater than second

Throws:

InvalidVersionFormatException - if the String parameter is not a valid Version

compareVersions

public static int compareVersions(java.lang.String ver1,
                                  Version ver2)
                           throws InvalidVersionFormatException

This method compares a String that represents a version to a Version

Parameters:

ver1 - String that contains version for comparison

ver2 - Version for comparison

Returns:

negative integer (-1) if the first version is lesser then the second, 0 if the versions are equal and positive integer (1) if the first version is greater than second

Throws:

InvalidVersionFormatException - if the String parameter is not a valid Version

compareVersions

public static int compareVersions(Version ver1,
                                  Version ver2)

This method compares two Version instances

Parameters:

ver1 - Version for comparison

ver2 - Version for comparison

Returns:

negative integer (-1) if the first version is lesser then the second, 0 if the versions are equal and positive integer (1) if the first version is greater than second

parseStringToInt

public static int parseStringToInt(java.lang.CharSequence num,
                                   int defaultValue,
                                   java.lang.String nullOrEmptyStringErrorMessage,
                                   java.lang.String numberFormatErrorMessage)

This method parses a String to its Numeric value. If parsing does not succeed because the String is not of appropriate number format the default numeric value is returned and appropriate error message is printed into log. Also if the String is blank or null the default value is returned and appropriate error message is printed into log. Note that logging relies on slf4j being present and appropriately configured by project that uses this utility. If nullOrEmptyStringErrorMessage or numberFormatErrorMessage parameters are null or empty Strings than the correlating error will not be printed.

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

nullOrEmptyStringErrorMessage - String that holds an error message that will printed into log if parameter num is null or blank

numberFormatErrorMessage - String that holds an error message that will printed into log if parameter num is not in appropriate format

Returns:

numeric value parsed from the String

parseStringToInt

public static int parseStringToInt(java.lang.CharSequence num,
                                   int defaultValue)

This method parses a String to its Numeric value silently. If parsing does not succeed because the String is not of appropriate number format or if the String is blank or null the default numeric value is returned but nothing is printed into the log. This method is equivalent to calling method parseStringToInt(CharSequence, int, String, String) with 2 last parameters set to null

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

Returns:

numeric value parsed from the String

parseStringToFloat

public static float parseStringToFloat(java.lang.CharSequence num,
                                       float defaultValue,
                                       java.lang.String nullOrEmptyStringErrorMessage,
                                       java.lang.String numberFormatErrorMessage)

This method parses a String to Numeric value. If parsing does not succeed because the String is not of appropriate number format the default numeric value is returned and appropriate error message is printed into log. Also if the String is blank or null the default value is returned and appropriate error message is printed into log. Note that logging relies on slf4j being present and appropriately configured by project that uses this utility. If nullOrEmptyStringErrorMessage or numberFormatErrorMessage parameters are null or empty Strings than the correlating error will not be printed.

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

nullOrEmptyStringErrorMessage - String that holds an error message that will printed into log if parameter num is null or blank

numberFormatErrorMessage - String that holds an error message that will printed into log if parameter num is not in appropriate format

Returns:

numeric value parsed from the String

parseStringToFloat

public static float parseStringToFloat(java.lang.CharSequence num,
                                       float defaultValue)

This method parses a String to its Numeric value silently. If parsing does not succeed because the String is not of appropriate number format or if the String is blank or null the default numeric value is returned but nothing is printed into the log. This method is equivalent to calling method parseStringToFloat(CharSequence, float, String, String) with 2 last parameters set to null

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

Returns:

numeric value parsed from the String

parseStringToByte

public static java.lang.Byte parseStringToByte(java.lang.CharSequence num,
                                               byte defaultValue,
                                               java.lang.String nullOrEmptyStringErrorMessage,
                                               java.lang.String numberFormatErrorMessage)

This method parses a String to Numeric value. If parsing does not succeed because the String is not of appropriate number format the default numeric value is returned and appropriate error message is printed into log. Also if the String is blank or null the default value is returned and appropriate error message is printed into log. Note that logging relies on slf4j being present and appropriately configured by project that uses this utility. If nullOrEmptyStringErrorMessage or numberFormatErrorMessage parameters are null or empty Strings than the correlating error will not be printed.

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

nullOrEmptyStringErrorMessage - String that holds an error message that will printed into log if parameter num is null or blank

numberFormatErrorMessage - String that holds an error message that will printed into log if parameter num is not in appropriate format

Returns:

numeric value parsed from the String

parseStringToByte

public static java.lang.Byte parseStringToByte(java.lang.CharSequence num,
                                               byte defaultValue)

This method parses a String to its Numeric value silently. If parsing does not succeed because the String is not of appropriate number format or if the String is blank or null the default numeric value is returned but nothing is printed into the log. This method is equivalent to calling method parseStringToByte(CharSequence, byte, String, String) with 2 last parameters set to null

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

Returns:

numeric value parsed from the String

parseStringToDouble

public static double parseStringToDouble(java.lang.CharSequence num,
                                         double defaultValue,
                                         java.lang.String nullOrEmptyStringErrorMessage,
                                         java.lang.String numberFormatErrorMessage)

This method parses a String to Numeric value. If parsing does not succeed because the String is not of appropriate number format the default numeric value is returned and appropriate error message is printed into log. Also if the String is blank or null the default value is returned and appropriate error message is printed into log. Note that logging relies on slf4j being present and appropriately configured by project that uses this utility. If nullOrEmptyStringErrorMessage or numberFormatErrorMessage parameters are null or empty Strings than the correlating error will not be printed.

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

nullOrEmptyStringErrorMessage - String that holds an error message that will printed into log if parameter num is null or blank

numberFormatErrorMessage - String that holds an error message that will printed into log if parameter num is not in appropriate format

Returns:

numeric value parsed from the String

parseStringToDouble

public static double parseStringToDouble(java.lang.CharSequence num,
                                         double defaultValue)

This method parses a String to its Numeric value silently. If parsing does not succeed because the String is not of appropriate number format or if the String is blank or null the default numeric value is returned but nothing is printed into the log. This method is equivalent to calling method parseStringToDouble(CharSequence, double, String, String) with 2 last parameters set to null

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

Returns:

numeric value parsed from the String

parseStringToLong

public static long parseStringToLong(java.lang.CharSequence num,
                                     long defaultValue,
                                     java.lang.String nullOrEmptyStringErrorMessage,
                                     java.lang.String numberFormatErrorMessage)

This method parses a String to Numeric value. If parsing does not succeed because the String is not of appropriate number format the default numeric value is returned and appropriate error message is printed into log. Also if the String is blank or null the default value is returned and appropriate error message is printed into log. Note that logging relies on slf4j being present and appropriately configured by project that uses this utility. If nullOrEmptyStringErrorMessage or numberFormatErrorMessage parameters are null or empty Strings than the correlating error will not be printed.

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

nullOrEmptyStringErrorMessage - String that holds an error message that will printed into log if parameter num is null or blank

numberFormatErrorMessage - String that holds an error message that will printed into log if parameter num is not in appropriate format

Returns:

numeric value parsed from the String

parseStringToLong

public static long parseStringToLong(java.lang.CharSequence num,
                                     long defaultValue)

This method parses a String to its Numeric value silently. If parsing does not succeed because the String is not of appropriate number format or if the String is blank or null the default numeric value is returned but nothing is printed into the log. This method is equivalent to calling method parseStringToLong(CharSequence, long, String, String) with 2 last parameters set to null

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

Returns:

numeric value parsed from the String

parseStringToShort

public static java.lang.Short parseStringToShort(java.lang.CharSequence num,
                                                 short defaultValue,
                                                 java.lang.String nullOrEmptyStringErrorMessage,
                                                 java.lang.String numberFormatErrorMessage)

This method parses a String to Numeric value. If parsing does not succeed because the String is not of appropriate number format the default numeric value is returned and appropriate error message is printed into log. Also if the String is blank or null the default value is returned and appropriate error message is printed into log. Note that logging relies on slf4j being present and appropriately configured by project that uses this utility. If nullOrEmptyStringErrorMessage or numberFormatErrorMessage parameters are null or empty Strings than the correlating error will not be printed.

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

nullOrEmptyStringErrorMessage - String that holds an error message that will printed into log if parameter num is null or blank

numberFormatErrorMessage - String that holds an error message that will printed into log if parameter num is not in appropriate format

Returns:

numeric value parsed from the String

parseStringToShort

public static java.lang.Short parseStringToShort(java.lang.CharSequence num,
                                                 short defaultValue)

This method parses a String to its Numeric value silently. If parsing does not succeed because the String is not of appropriate number format or if the String is blank or null the default numeric value is returned but nothing is printed into the log. This method is equivalent to calling method parseStringToShort(CharSequence, short, String, String) with 2 last parameters set to null

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

Returns:

numeric value parsed from the String

parseStringToTimeInterval

public static TimeInterval parseStringToTimeInterval(java.lang.String valueStr)
                                              throws java.lang.IllegalArgumentException

This method parses String value into TimeInterval. This method supports time interval suffixes "s" for seconds, "m" for minutes, "h" for hours, and "d" for days. Suffix is case insensitive. If String parameter contains no suffix the default is milliseconds. So for example string "38s" will be parsed as 38 seconds, "24m" - 24 minutes "4h" - 4 hours, "3d" - 3 days and "45" as 45 milliseconds. If the string parses to a negative numerical value or 0 or the string is not a valid numerical value then IllegalArgumentException is thrown. Note that it is very convenient to extract time value from TimeInterval, See methods TimeInterval.toMillis(), TimeInterval.toSeconds(), TimeInterval.toMinutes(), TimeInterval.toHours(), TimeInterval.toDays().

This method may be very useful for parsing time interval properties such as timeouts or waiting periods from configuration files. It eliminates unneeded calculations from different time scales to milliseconds back and forth. Consider that you have a methodInvokingInterval property that you need to set for 5 days. So in order to set the miliseconds value you will need to calculate that 5 days is 432000000 milliseconds (obviously not an impossible task but annoying and error prone) and then anyone else who sees the value 432000000 will have to calculate it back to 5 days which is frustrating. But using this method you will have a property value set to "5d" and invoking the code

long milliseconds = TextUtils.parseStringToTimeInterval("5d").toMillis();

will solve your conversion problem

Parameters:

valueStr - String value to parse to TimeInterval

Returns:

TimeInterval parsed from the String

Throws:

java.lang.IllegalArgumentException - if parsed value has invalid suffix, invalid numeric value or negative numeric value or 0

parsingStringToTimeInterval

public static TimeInterval parsingStringToTimeInterval(java.lang.String valueStr)
                                                throws java.lang.IllegalArgumentException

Deprecated. Use parseStringToTimeInterval(String) instead. The new method the same as this one except the name change. This method is left for backwards compatibility only and will be removed in future versions.

Parameters:

valueStr - String value to parse to TimeInterval

Returns:

TimeInterval parsed from the String

Throws:

java.lang.IllegalArgumentException - if parsed value has invalid suffix, invalid numeric value or negative numeric value or 0

parseStringToBigDecimal

public static java.math.BigDecimal parseStringToBigDecimal(java.lang.CharSequence num,
                                                           java.math.BigDecimal defaultValue,
                                                           java.lang.String nullOrEmptyStringErrorMessage,
                                                           java.lang.String numberFormatErrorMessage)

This method parses a String to BigDecimal value. If parsing does not succeed because the String is not of appropriate number format the default numeric value is returned and appropriate error message is printed into log. Also if the String is blank or null the default value is returned and appropriate error message is printed into log. Note that logging relies on slf4j being present and appropriately configured by project that uses this utility. If nullOrEmptyStringErrorMessage or numberFormatErrorMessage parameters are null or empty Strings than the correlating error will not be printed.

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

nullOrEmptyStringErrorMessage - String that holds an error message that will printed into log if parameter num is null or blank

numberFormatErrorMessage - String that holds an error message that will printed into log if parameter num is not in appropriate format

Returns:

BigDecimal value parsed from the String

parseStringToBigDecimal

public static java.math.BigDecimal parseStringToBigDecimal(java.lang.CharSequence num,
                                                           java.math.BigDecimal defaultValue)

This method parses a String to its BigDecimal value silently. If parsing does not succeed because the String is not of appropriate number format or if the String is blank or null the default numeric value is returned but nothing is printed into the log. This method is equivalent to calling method parseStringToBigDecimal(CharSequence, BigDecimal, String, String) with 2 last parameters set to null

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

Returns:

numeric value parsed from the String

parseStringToBigInteger

public static java.math.BigInteger parseStringToBigInteger(java.lang.CharSequence num,
                                                           java.math.BigInteger defaultValue,
                                                           java.lang.String nullOrEmptyStringErrorMessage,
                                                           java.lang.String numberFormatErrorMessage)

This method parses a String to BigInteger value. If parsing does not succeed because the String is not of appropriate number format the default numeric value is returned and appropriate error message is printed into log. Also if the String is blank or null the default value is returned and appropriate error message is printed into log. Note that logging relies on slf4j being present and appropriately configured by project that uses this utility. If nullOrEmptyStringErrorMessage or numberFormatErrorMessage parameters are null or empty Strings than the correlating error will not be printed.

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

nullOrEmptyStringErrorMessage - String that holds an error message that will printed into log if parameter num is null or blank

numberFormatErrorMessage - String that holds an error message that will printed into log if parameter num is not in appropriate format

Returns:

BigInteger value parsed from the String

parseStringToBigInteger

public static java.math.BigInteger parseStringToBigInteger(java.lang.CharSequence num,
                                                           java.math.BigInteger defaultValue)

This method parses a String to its BigInteger value silently. If parsing does not succeed because the String is not of appropriate number format or if the String is blank or null the default numeric value is returned but nothing is printed into the log. This method is equivalent to calling method parseStringToBigInteger(CharSequence, BigInteger, String, String) with 2 last parameters set to null

Parameters:

num - CharSequence to be parsed

defaultValue - value that will be returned by this method if parsing of the String failed

Returns:

numeric value parsed from the String

getStacktrace

public static java.lang.String getStacktrace(java.lang.Throwable e,
                                             boolean cutTBS,
                                             java.lang.String... relevantPackages)

This method retrieves a stacktrace from Throwable as a String in full or shortened format. Shortened format skips the lines in the stacktrace that do not start with one of the package prefixes in configurable package prefix list and replaces them with "..." line. The stacktrace is viewed as consisting possibly of several parts. If stacktrace contains "caused by" or "Suppressed" section, each such section for the purposes of this utility is called "Singular stacktrace". For example the stacktrace bellow contains 2 singular stacktraces: First is 4 top lines and the second starting from the line "Caused by: ..." and to the end.

java.lang.Exception: Bad error
  at com.plain.analytics.v2.utils.test.UtilsTester.TestGetStackTrace(UtilsTester.java:80)
  at com.plain.analytics.v2.utils.test.UtilsTester.run(UtilsTester.java:30)
  at com.plain.analytics.v2.utils.test.UtilsTester.main(UtilsTester.java:25)
Caused by: java.lang.NumberFormatException: For input string: "Hello"
  at java.lang.NumberFormatException.forInputString(Unknown Source)
  at java.lang.Integer.parseInt(Unknown Source)
  at java.lang.Integer.parseInt(Unknown Source)
  at com.plain.analytics.v2.utils.test2.UtilsTesterHelper.parseInt(UtilsTesterHelper.java:8)
  at com.plain.analytics.v2.utils.test.UtilsTester$Invoker.runParser(UtilsTester.java:97)
  at com.plain.analytics.v2.utils.test2.UtilsTesterHelper.innerInvokeParser(UtilsTesterHelper.java:17)
  at com.plain.analytics.v2.utils.test2.UtilsTesterHelper.invokeParser(UtilsTesterHelper.java:12)
  at com.plain.analytics.v2.utils.test.UtilsTester.TestGetStackTrace(UtilsTester.java:76)
  ... 2 more

The way this method shortens the stacktrace is as follows. Each "singular" stacktrace is analyzed and shortened separately. For each singular stacktrace the error message is always printed. Then all the lines that follow are printed even if they do not start with one of the prefixes specified by relevantPackages. Once the first line that starts with one of the prefixes is found this line and all immediately following lines that start with one of the relevant package prefixes are printed as well. The first line that does not start with any of the prefixes after a section of the lines that did is also printed. But all the following lines that do not start with any of the prefixes are skipped and replaced with a single line "...". If at some point within the stacktrace a line that starts with one of the prefixes is encountered again this line and all the following lines that start with one of the prefixes + one following line that does not start with any of the prefixes are printed in. And so on. Here is an example: Assume that exception above was passed as a parameter to this method and parameter relevantPackages is set to ["com.plain.analytics.v2.utils.test."] which means that the lines starting with that prefix are the important or "relevant" lines. (Also the parameter cutTBS set to true which means that stacktrace should be shortened. In this case the result of this method should be as follows:

java.lang.Exception: Bad error
  at com.plain.analytics.v2.utils.test.UtilsTester.TestGetStackTrace(UtilsTester.java:80)
  at com.plain.analytics.v2.utils.test.UtilsTester.run(UtilsTester.java:30)
  at com.plain.analytics.v2.utils.test.UtilsTester.main(UtilsTester.java:25)
Caused by: java.lang.NumberFormatException: For input string: "Hello"
  at java.lang.NumberFormatException.forInputString(Unknown Source)
  at java.lang.Integer.parseInt(Unknown Source)
  at java.lang.Integer.parseInt(Unknown Source)
  at com.plain.analytics.v2.utils.test2.UtilsTesterHelper.parseInt(UtilsTesterHelper.java:8)
  at com.plain.analytics.v2.utils.test.UtilsTester$Invoker.runParser(UtilsTester.java:97)
  at com.plain.analytics.v2.utils.test2.UtilsTesterHelper.innerInvokeParser(UtilsTesterHelper.java:17)
  ...
  at com.plain.analytics.v2.utils.test.UtilsTester.TestGetStackTrace(UtilsTester.java:76)
  ... 2 more

Note that the first singular stacktrace is printed in full because all the lines start with the required prefix. The second singular stacktrace prints the first 7 lines because at first all the lines are printed until the first line with one of the relevant prefixes is found, and then all the lines with the prefix (one in our case) are printed + plus one following line without the prefix. And then the second line without the prefix (3d from the bottom) is skipped and replaced with line "...". But then again we encounter a line with the prefix which is printed and finally the last line is printed because it is the first line without prefix following the one with the prefix. In this particular example only one line was skipped over, which is not very much, but for web-based environments for the long stacktraces that contain long traces of server related classes this method could be very effective in removing irrelevant lines and leaving only application related lines making log files more concise and clear.

Important Note: Parameter relevantPackages may be left null. In this case the value of relevant package prefix will be taken from RelevantPackages property (See the methods setRelevantPackage(String...) and getRelevantPackage()). Using method setRelevantPackage(String...) to set the value will preset the values of relevant package prefixes for all calls for which parameter relevantPackages is null. In fact there is a convenience method getStacktrace(Throwable, boolean) that invokes this method with parameter relevantPackages set to null and relies on the globally set property through method setRelevantPackage(String...). However if the global property was not set and parameter relevantPackages was left null then the method will return stacktrace in full as if the parameter cutTBS was set to false

Parameters:

e - Throwable from which stacktrace should be retrieved

cutTBS - boolean that specifies if stacktrace should be shortened. The stacktrace should be shortened if this flag is set to true. Note that if this parameter set to false the stacktrace will be printed in full and parameter relevantPackages becomes irrelevant.

relevantPackages - String... that contains the prefix or several prefixes specifying which lines are relevant. It is recommended to be in the following format "packag_name1.[package_name2.[...]]." In the example above it should be "com.plain.analytics.v2.utils.test.".

Returns:

String with stacktrace value

getStacktrace

public static java.lang.String getStacktrace(java.lang.Throwable e,
                                             boolean cutTBS)

This method retrieves a stacktrace from Throwable as a String in full or shortened format. This is convenience method that invokes method getStacktrace(Throwable, boolean, String...) with last parameter as null. It relies on relevant package prefix to have been set by method setRelevantPackage(String...). There are several ways to pre-invoke method setRelevantPackage(String...):

• Set system environment variable "MGNT_RELEVANT_PACKAGE" with relevant package value (for the purposes of our example it would be "com.plain.")
• Run your code with System property "mgnt.relevant.package" set to relevant package value It could be done with -D: "-Dmgnt.relevant.package=com.plain." Note that System property value would take precedence over environment variable if both are set.
  IMOPRTANT: Note that for both environment variable and system property if multiple prefixes needed to be set than list them one after another separated by semicolon (;)
  For Example: "com.plain.;com.encrypted."
• In case when Spring framework is used and system property and environment variable described above are not used then it is recommended to add the following bean into your Spring configuration xml file. This will ensure an invocation of method setRelevantPackage(String...) which will appropriately initialize the package prefix and enable the use of this method

  <bean class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
  <property name="targetClass" value="com.mgnt.utils.TextUtils"/>
  <property name="targetMethod" value="setRelevantPackage"/>
  <property name="arguments" value="com.plain."/>
  </bean>

Parameters:

e - Throwable from which stacktrace should be retrieved

cutTBS - boolean flag that specifies if stacktrace should be shortened or not. It is shortened if the flag value is true

Returns:

String that contains the stacktrace

See Also:

getStacktrace(Throwable, boolean, String...)

getStacktrace

public static java.lang.String getStacktrace(java.lang.Throwable e)

This method retrieves a stacktrace from Throwable as a String in shortened format. This is convenience method that invokes method getStacktrace(Throwable, boolean, String...) with second parameter set to 'true' and last parameter as null. It relies on relevant package prefix to have been set by method setRelevantPackage(String...). There are several ways to pre-invoke method setRelevantPackage(String...):

• Set system environment variable "MGNT_RELEVANT_PACKAGE" with relevant package value (for the purposes of our example it would be "com.plain.")
• Run your code with System property "mgnt.relevant.package" set to relevant package value It could be done with -D: "-Dmgnt.relevant.package=com.plain." Note that System property value would take precedence over environment variable if both are set.
  IMOPRTANT: Note that for both environment variable and system property if multiple prefixes needed to be set * than list them one after another separated by semicolon (;)
  For Example: "com.plain.;com.encrypted."
• In case when Spring framework is used and system property and environment variable described above are not used then it is recommended to add the following bean into your Spring configuration xml file. This will ensure an invocation of method setRelevantPackage(String...) which will appropriately initialize the package prefix and enable the use of this method

  <bean class="org.springframework.beans.factory.config.MethodInvokingFactoryBean">
  <property name="targetClass" value="com.mgnt.utils.TextUtils"/>
  <property name="targetMethod" value="setRelevantPackage"/>
  <property name="arguments" value="com.plain."/>
  </bean>

Parameters:

e - Throwable from which stacktrace should be retrieved

Returns:

String that contains the stacktrace

See Also:

getStacktrace(Throwable, boolean, String...)

getStacktrace

public static java.lang.String getStacktrace(java.lang.Throwable e,
                                             java.lang.String... relevantPackages)

This method retrieves a stacktrace from Throwable as a String in shortened format. This is convenience method that invokes method getStacktrace(Throwable, boolean, String...) with second parameter set to 'true'.

Parameters:

e - Throwable from which stacktrace should be retrieved

relevantPackages - String... that contains the prefix or several prefixes specifying which lines are relevant. It is recommended that each prefix should be in the following format "packag_name1.[package_name2.[...]]."

Returns:

String that contains the stacktrace

See Also:

getStacktrace(Throwable, boolean, String...)

getStacktrace

public static java.lang.String getStacktrace(java.lang.CharSequence stacktrace,
                                             java.lang.String... relevantPackages)

This method retrieves a stacktrace in shortened format from source stactrace provided as CharSequence. Since this method receives stacktrace as a CharSequence, it is assumed that it is always desirable to get shortened format since the full stacktrace is already available as a CharSequence. To shorten the original stacktrace this method processes the stacktrace exactly as described in method getStacktrace(Throwable, boolean, String...).

Parameters:

stacktrace - CharSequence that holds full stacktrace text

relevantPackages - String... that contains the prefix or several prefixes specifying which lines are relevant. It is recommended that each prefix should be in the following format "packag_name1.[package_name2.[...]]." (Again for full explanation on how this parameter (and the entire method) works see the method getStacktrace(Throwable, boolean, String...).

Returns:

Stacktrace string in shortened format

Since:

1.5.0.3

See Also:

getStacktrace(Throwable, boolean, String...)

getStacktrace

public static java.lang.String getStacktrace(java.lang.CharSequence stacktrace)

This method retrieves a stacktrace in shortened format from source stacktrace provided as CharSequence. This is convenience method that works the same way as method getStacktrace(CharSequence, String...) with second parameter set to null. It relies on relevant package prefix to have been set by method setRelevantPackage(String...). There are several options to pre-set this value. For detailed explanation of these options see method getStacktrace(Throwable, boolean). Since this method receives stacktrace as a CharSequence, it is assumed that it is always desirable to get shortened format since the full stacktrace is already available as a CharSequence

Parameters:

stacktrace - CharSequence that holds full stacktrace text

Returns:

Stacktrace string in shortened format

Since:

1.5.0.3

See Also:

getStacktrace(Throwable, boolean)

getRelevantPackage

public static java.lang.String[] getRelevantPackage()

This a getter method for global value of relevant package prefix property

Returns:

String that holds the prefix value.

setRelevantPackage

public static void setRelevantPackage(java.lang.String... relevantPackages)

This is a setter method for relevant package prefix array property for method getStacktrace(Throwable, boolean) Once the value has been set the convenience method getStacktrace(Throwable, boolean) could be used instead of method getStacktrace(Throwable, boolean, String...)

Parameters:

relevantPackages - String... that contains the prefix or several prefixes specifying which lines are relevant. It is recommended to be in the following format "package_name1.[package_name2.[...]]."

See Also:

getStacktrace(Throwable, boolean, String...)

formatStringToPreserveIndentationForHtml

public static java.lang.String formatStringToPreserveIndentationForHtml(java.lang.String rawText)

This method converts a String in such a way that its spaces are not modified by HTML renderer i.e. it replaces regular space characters with non-breaking spaces known as '&nbsp;' but they look in your source as regular space ' ' and not as '&nbsp;' It also replaces new line character with '<br>'. Here is an example. Lets say that you would like to write a text that has indentations So you can not simply write something like

This is non-indented line
This is 2 spaces indented line
This is 4 spaces indented line

Such a text after rendered by html would result into single non-indented line:

This is non-indented line This is 2 spaces indented line This is 4 spaces indented line

The solution would be to write your text as follows:

This is non-indented line<br>
&nbsp;&nbsp;This is 2 spaces indented line<br>
&nbsp;&nbsp;&nbsp;&nbsp;This is 4 spaces indented line

That works just fine once rendered in HTML but your source now is not very readable and difficult to maintain if you want to modify your indentations. So in order to remedy this you can pass your original string to this method, say the string looks like this:

This is non-indented line
This is 2 spaces indented line
This is 4 spaces indented line

And it will return you the string that looks like this:

This is non-indented line<br>
This is 2 spaces indented line<br>
This is 4 spaces indented line<br>

Except, that besides visible addition of <br> at the end of the lines your regular spaces (U+0020) have been replaced with non-breaking spaces (U+00A0) but they look the same in your source. So if you just place this modified string into your HTML source code your indentation will be preserved and you source code is readable.
IMPORTANT NOTE: if you want to modify indentations later you can NOT just type additional spaces. You will have to either use this method again after you modified your string or you can copy-pace those "normal looking" but actually non-breaking spaces. Also this was tested and found to be working with just regular HTML, but in combination with javascript it could sometimes produce unexpected results and instead of "normal-looking" space may show an 'Â' symbol. So, this method has its limitations. Test your results before you deliver. Use this method at your own risk. ☺

Parameters:

rawText - to be converted

Returns:

String that is converted as described above