Field Detail

• public static final java.lang.String BREAK_LINE_HTML_TAG

  Html tag that is used for breaking lines

• public static final char CHAR_WITH_ZERO_WIDTH

  Zero-width space

• public static final char DEFAULT_CSV_DELIMITER

  Default Comma-Separated-Values sign

• public static final char DEFAULT_FILENAME_WHITESPACE_CHAR

  Default char that it used instead of whitespaces in file names

• public static final java.lang.String DEFAULT_NEWLINE

  New line elements that are considered default

• public static final char ELLIPSIS

  Series of three dots as a symbol

• public static final java.lang.String EMPTY

• public static final java.lang.String NEWLINE

  OS dependent line separator

Method Detail

• public static java.lang.String addEndingDotIfNecessary(@Nullable java.lang.String value)

  Puts a full stop at the end of the sentence, if there is no dot

  Parameters:

  value - the provided String in the end of which a full stop should be put

  Returns:

  the String ends with dot initial String in case if there was a dot in the end of it.

• public static java.lang.String capitalize(java.lang.String string)

  Null safe method; capitalizes the word

  Parameters:

  string - the initial word

  Returns:

  the capitalized word

• public static java.lang.String createFileName(java.lang.String str, char whitespaceChar)

  Replaces whitespaces from the file name

  Parameters:

  str - the file name where all the whitespaces should be replaced with a specified symbol whitespaceChar

  whitespaceChar - the symbol that replaces all the whitespace in the file name

  Returns:

  the filename without whitespaces

• public static java.lang.String createFileName(java.lang.String str)

  Replaces the whitespaces from the file name replacing them with the DEFAULT_FILENAME_WHITESPACE_CHAR

  Parameters:

  str - the filename where all the whitespaces should be replaced with DEFAULT_FILENAME_WHITESPACE_CHAR

  Returns:

  the String with the replaced whitespaces

• public static java.lang.String createFileName2(java.lang.String str, char replace)

  Replaces all non letter and non digit characters from the file name

  Parameters:

  str - the file name

  replace - the symbol for replacing

  Returns:

  the filename where all non-letter and non-digit symbols was replaced with the provided symbol

• public static java.io.Writer createSeparatedRow(java.io.Writer writer, StringList values, char separator, char quote)

  Splits the content of the provided StringList with the specified separator and frame each word with the specified quotation marks

  Parameters:

  writer - character stream which contains result

  values - list of Strings

  separator - char that separates words

  quote - char that is used as a quotation mark to frame each word

  Returns:

  a Writer with transformed Strings

• public static java.lang.String createXmlName(java.lang.String str)

  Creates the appropriate name for the file in xml format by removing all the unacceptable symbols. This method also validate file name {

  See Also:

  StringUtils.isValidXmlName

  Parameters:

  str - the initial {@code String

  Returns:

  the file name without unacceptable symbols

• public static java.lang.String decapitalize(java.lang.String name)

• public static java.lang.String emptyIfNull(java.lang.String baseString)

  Converts the String into a null safe parameter

  Parameters:

  baseString - the null safe String

  Returns:

  the empty String in case when provided baseString is null or empty, else the method returns initial baseString

• public static java.lang.String fixLineSeparator(java.lang.String xml)

  Null safe method, replaces all the line separators to OS friendly ones

  Parameters:

  xml - the String to be transformed

  Returns:

  the transformed String

• public static java.lang.String getEncodedStringSafely(byte[] bytes, java.lang.String encoding)

  Constructs the new String by decoding the provided array of bytes using the the specified charset

  Parameters:

  bytes - the array of bytes to be decoded into String

  encoding - the name of a supported java.nio.charset.Charset

  Returns:

  the decoded String

• public static java.lang.String getSubstringBeforeFirstWhitespace(java.lang.String originalString)

  Returns a String that is positioned before the first whitespace in the specified text

  Parameters:

  originalString - the String to be cut

  Returns:

  the String that contains all the symbols before the first whitespace in initial String

• public static java.lang.String getValidFileName(java.lang.String name)

  Replaces all the punctuation marks with the underscore symbol

  Parameters:

  name - the String with the punctuation marks in its structure

  Returns:

  the String without any punctuation marks

• public static boolean hasContent(@Nullable java.lang.String str)

  Checks if there any content in the provided String

  Parameters:

  str - the word to be checked

  Returns:

  true if there is any content in the str, false otherwise

• public static boolean isBlank(java.lang.String string)

• public static boolean isNullOrEmpty(java.lang.String str)

  Checks if the input string is empty or null

  Parameters:

  str - the word for checking

  Returns:

  the boolean variable that reflects checking result

• public static boolean isNumeric(java.lang.String s)

  Null safe method; checks if the String is numeric

  Parameters:

  s - the String to be checked

  Returns:

  true if the provided String consists of decimal or floating-point number, admits '+' and 'minus' symbols beforehead, returns false if the provided String is null or its content is not numeric

• public static boolean isValidTagName(java.lang.String tagName)

  Checks if the tag name is valid

  Parameters:

  tagName - the tag to be checked

  Returns:

  true if provided String matches following conditions: - not null - not empty - the length of it is less or equal to StringUtils#MAX_TAG_LEN - should consists of letters or whitespaces and letters returns false in any other case.

• public static java.lang.String join(java.lang.String[] array, java.lang.String separator)

  Builds a String from the array elements and separates them with provided separator

  Parameters:

  array - the initial array all the elements of which should be united

  separator - the word that should separate united elements

  Returns:

  theString from the array contents

• public static java.lang.String maybePlural(java.lang.String str, int count)

  Simplest possible pluralization of provided word by adding an 's' to it

  Parameters:

  str - the word to be pluralized

  count - should be equals any number but 1 in order to evaluate transformation

  Returns:

  the pluralized word or the initial one in case count was equal to 1

• public static java.lang.String[] merge(java.lang.String[] incomingNames, java.lang.String string)

  Increases the size of a String array, adding the provided String to it.

  Parameters:

  incomingNames - the initial array to be increased

  string - the String that should be added into incomingNames

  Returns:

  the new array that is filled with the values of incomingNames and string

• public static java.lang.String normalizeSpace(java.lang.String str)

  Removes multiple whitespaces if any of them appears in the provided text, replacing them with single ones

  Parameters:

  str - null safe parameter; the text to be formatted

  Returns:

  the String with absence of multiple whitespaces; returns the empty String in case if the initial text is empty

• public static java.lang.String nullIfEmtpy(java.lang.String string)

  Handles the input String, this method returns null, if it is empty or null

  Parameters:

  string - the word for handling

  Returns:

  null if provided string is empty or consists of whitespace/s only, else the method returns the initial word

• public static int parseInt(java.lang.String str, int defaultValue)

  Parses the string argument into a signed decimal integer; null safe method

  Parameters:

  str - the String to be parsed

  defaultValue - returns this value in case of the str parameter is null or {@exception NullFormatException}

  Returns:

  provided default value in any case it can not parse the string as a number, else returns proper integer

• public static java.lang.String quote(java.lang.String str)

  Null safe method; surrounds the initial String with double quotes

  Parameters:

  str - the initial String; it should not starts or end with double quotes

  Returns:

  String surrounded by double quotes

• public static StringList readSeparatedRow(java.lang.String row, char separator, char quote)

  Converts the text which was created by StringUtils.createSeparatedRow to StringList

  Parameters:

  row - the provided String to be separated

  separator - the char element which is considered as a separating element

  quote - the quotation mark which is used in the row

  Returns:

  the StringList that consists of provided String elements

  See Also:

  StringUtils.createSeparatedRow

• public static java.lang.String removeSingleAndDoubleQuotes(java.lang.String input)

  Removes leading and trailing whitespaces and single or double quotes from the provided string

  Parameters:

  input - the word to be transformed

  Returns:

  the word without leading and trailing whitespaces and single or double quotation marks

• public static java.lang.String repeat(java.lang.String s, int count)

  Repeats the String as many times as it was asked for

  Parameters:

  s - null safe parameter; the text to be repeated

  count - the decimal parameter that shows the necessarily number of repeating

  Returns:

  the String that was copied as many times as the count variable determined

• public static java.lang.String replace(java.lang.String data, java.lang.String from, java.lang.String to)

  Replaces the provided part of a String with another one, the 'case insensitivity' option is false by default

  Parameters:

  data - the provided String to be changed

  from - the part of the data that should be changed

  to - from will be changed to that variable

  Returns:

  the transformed String

  See Also:

  StringUtils.replace

  StringUtils.replace

• public static java.lang.String replace(java.lang.String data, java.lang.String from, java.lang.String to, boolean caseInsensitive)

  Replaces the provided part in a String with another one with presence of the case insensitivity option

  Parameters:

  data - the String to be changed

  from - the part of the data that should be changed

  to - from will be changed to that variable

  caseInsensitive - the case insensitivity option

  Returns:

  the transformed String

  See Also:

  StringUtils.replace

  StringUtils.replace

• public static java.lang.String replace(java.lang.String data, java.lang.String from, java.lang.String to, boolean caseInsensitive, boolean firstOnly)

  Replaces the provided part in a String with another one with the case insensitivity option. Also it allows to choose either one or every entry should be changed

  Parameters:

  data - the String to be changed

  from - the part of the data that should be changed

  to - from will be changed to that variable

  caseInsensitive - the setting of case-sensitivity; true - ignore case, false - consider case

  firstOnly - the setting that figured out if the first entry only should be replaced

  Returns:

  the transformed String

• public static java.lang.String replaceFirst(java.lang.String data, java.lang.String from, java.lang.String to, boolean caseInsensitive)

  Replaces the first entry of the provided part in a String with another one with the case insensitivity option

  Parameters:

  data - the String to be changed

  from - the part of the data that should be changed

  to - from will be changed to that variable

  caseInsensitive - the case insensitivity option

  Returns:

  the transformed String

• public static java.lang.String replaceRegExUnescaped(java.lang.String text)

  Replaces escaped sequences in the provided String by adding leading backslash

  Parameters:

  text - the initial String in which there are symbols to be replaced

  Returns:

  the String in which escaped sequences were replaced by adding leading backslash

• public static boolean sameString(@Nullable java.lang.String str1, @Nullable java.lang.String str2)

  Null safe method that checks if provided strings are equal to each other

  Parameters:

  str1 - The first word to compare

  str2 - The second word to compare

  Returns:

  true if both of the arguments are nullable or they are equal to each other considering case; false otherwise

• public static boolean sameStringLists(@Nullable java.util.List<java.lang.String> strList1, @Nullable java.util.List<java.lang.String> strList2)

  Null safe method checks if provided string lists are equal to each other. According to this method the lists are equal if they both are null or contain the same amount of equal items.

  Parameters:

  strList1 - The first string list to compare

  strList2 - The second string list to compare

  Returns:

  true if the arguments are equal to each other, or both of them are null; false otherwise

• public static boolean sameText(@Nullable java.lang.String str1, @Nullable java.lang.String str2)

  Null safe method checks if provided strings are equal to each other ignoring case

  Parameters:

  str1 - The first word to compare

  str2 - The second word to compare

  Returns:

  true if the arguments are equal to each other ignoring case, or both of them are nullable; false otherwise

• public static java.lang.String sanitizeFilename(java.lang.String name)

  Replaces a pound sign with the proper unicode symbol, also replaces the symbols that are incorrect for file naming with a dash

  Parameters:

  name - the provided file name

  Returns:

  the file name that was transformed

• public static java.lang.String singleQuote(java.lang.String str)

  Null safe method; surrounds initial String with single quotes

  Parameters:

  str - the initial String; it should not starts or end with single quotes

  Returns:

  the String surrounded by single quotes

• public static java.lang.String[] sortNames(java.lang.String[] names)

  Sorts the String array according to Comparable natural ordering of its elements

  Parameters:

  names - the array to be sorted

  Returns:

  the sorted array

• @java.lang.Deprecated public static java.lang.String spacifyOnCapital(java.lang.String name)

  deprecated:

  replaced by StringUtils.specifyOnCapital

• public static java.lang.String specifyOnCapital(java.lang.String name)

  Separates the word with the whitespace aligning capital letters, also the method trims the leading and trailing whitespaces.

  code:

  String} to be changed

  Parameters:

  name - {the

  Returns:

  the separated String

• public static java.util.List<java.lang.String> splitLines(java.lang.String string)

  Splits the text by lines

  Parameters:

  string - the text to be split, not null value is required

  Returns:

  list consisted of java.lang.Strings that were split by lines from the initial string

• public static boolean startsWithCaseInsensitive(java.lang.String string, java.lang.String prefix)

  Checks if the provided string begins with the specified prefix ignoring case

  Parameters:

  string - the initial String to be validated

  prefix - the String prefix for validating

  Returns:

  true if the string begins with the prefix ignoring case; else returns false

• public static java.lang.String stripStartAndEnd(java.lang.String s, java.lang.String start, java.lang.String end)

  Truncates the String according to given parameters

  Parameters:

  s - the String to be truncated

  start - should be equal to the beginning of the s to remove it from the provided s

  end - should be equal to the end of the s to remove it from provided s

  Returns:

  truncated String

• public static java.lang.String toHtml(java.lang.String string)

  Transforms the String to the content of an html format document with the default max size that is 0

  Parameters:

  string - the initital String to be transformed

  Returns:

  the transformed String

  See Also:

  StringUtils.toHtml

• public static java.lang.String toHtml(java.lang.String string, int maxSize)

  Transforms the String to the content of a simple html format document, taking down the initial string with
  tag depending on the presence of the newline characters in the string

  Parameters:

  string - the initial String to be transformed

  maxSize - limits the length of the result String, it includes the default opening tags length () and the text that precede the newline character. The excess text is replaced by ellipses. 0 value means infinite size of the resulting text any other value restricts result String

  Returns:

  the String that is transformed into the content of an html format document

• public static java.lang.String toString(java.lang.Object object)

  Returns the String representation of a provided {@code} Object

  Parameters:

  object - the object which toString() method we want to call

  Returns:

  the String representation of an Object

• public static java.lang.String[] toStringArray(java.lang.Object[] selectedOptions)

  Returns the String array representation of the provided Object array

  Parameters:

  selectedOptions - the array every element of which should be represent as a String element in the array

  Returns:

  the array that represents each object as a String

• public static java.util.List<java.lang.String> toStringList(java.lang.Object[] selectedOptions)

  Returns the List<String> representation of the provided Object array

  Parameters:

  selectedOptions - the array every element of which should be represent as a String element in List

  Returns:

  the List consisted of Strings, which was created from an array of Objects

• public static java.lang.String toStringOrEmpty(java.lang.Object toString)

• public static java.lang.String toStringOrNull(java.lang.Object toString)

  Null safe method, that transforms the provided Object to the String.

  Parameters:

  toString - an object to be converted to String

  Returns:

  the result of provided toString#toString() method

  See Also:

  java.lang.Object#toString()

• public static java.lang.String trimRight(java.lang.String str, java.lang.String substring)

  Trims the end of the word as many times as it equals to provided substring

  Parameters:

  str - null safe parameter; Provided value should ends with substring for proper transformation

  substring - the sequence of characters to be truncated from the word

  Returns:

  the shortened word

• public static java.lang.String truncate(java.lang.String originalString, int limit)

  Reduces the length of the provided String in order to reach the limit

  Parameters:

  originalString - null safe String parameter; the word to be truncated

  limit - the length of the resulting word. That value should be shorter than the length of the initial str

  Returns:

  truncated word with the ellipsis at the end of it, returns empty String if str was null

• public static java.lang.String truncate(java.lang.String originalString, int limit, java.lang.String ending)

  Parameters:

  originalString

  limit

  ending

  Returns:

• public static java.lang.String truncateStart(java.lang.String str, int limit)

  Truncates the beginning of the word in order to reach limit

  Parameters:

  str - the word to be truncated

  limit - the length of the resulting word. That value should be shorter than the length of provided str

  Returns:

  truncated word, the limit of which includes the ellipsis at the beginning of it

• public static java.lang.String truncateStartOfUrl(java.lang.String urlString, int limit)

  Truncates the query parameters from the String url and then cuts it from the beginning to reach the limit. Removed symbols will be replaced with the ellipsis

  Parameters:

  urlString - url to be truncated

  limit - quantity of symbols that should remain in url including ellipsis symbols

  Returns:

  truncated url, the limit of which includes the ellipsis

• public static java.lang.String truncateUrl(java.lang.String urlString, int limit)

  Truncates the query parameters from the String url and then cuts it from the end to reach the limit. Removed symbols will be replaced with the ellipsis

  Parameters:

  urlString - the url to be truncated

  limit - the quantity of symbols that should remain in url

  Returns:

  truncated url

• public static java.lang.String unquote(java.lang.String str)

  Removes leading and trailing double quotes from the provided string

  Parameters:

  str - null safe String parameter to be transformed. It should begins and ends with double quotation marks for proper transformation

  Returns:

  a word without double quotation marks if its length more than 0 and it begins and ends with double quotation marks

• public static java.lang.String unquoteStartAndEnd(java.lang.String str)

  Removes leading and/or trailing double quotes from the provided string

  Parameters:

  str - null safe String parameter to be transformed. It should begins and/or ends with double quotation marks for proper transformation

  Returns:

  a word without double quotation marks if its length more than 0 and it begins and/or ends with double quotation marks