MString (mhu-lib-core 3.2.6 API)

java.lang.Object
- de.mhus.lib.core.MString

```
public class MString
extends Object
```
Author:

hummel To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHARSET_DEFAULT`
`static String`	`CHARSET_ISO_8859_1`
`static String`	`CHARSET_UTF_16`
`static String`	`CHARSET_UTF_8`
`static String`	`DEFAULT_SEPARATOR`
`static char[]`	`WHITESPACE`

Constructor Summary

Constructors
Constructor and Description

MString()

Constructors
Constructor and Description
`MString()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`afterIndex(String _s, char _c)` Return the string after _c in _s.
`static String`	`afterIndex(String _s, char[] _c)` Return the string after _c in _s.
`static String`	`afterLastIndex(String string, char c)` Return the part after the last occurrence of the char.
`static void`	`appendRepeating(int amount, char fill, StringBuffer buffer)` Append the number of times a character to a string buffer.
`static String`	`beforeIndex(String _s, char _c)` Return the string before _c in _s.
`static String`	`beforeIndex(String _s, char[] _c)` Return the string before _c in _s.
`static String`	`beforeLastIndex(String string, char c)` Return part before last occurrence of the char.
`static String`	`canonical(String s)` Convert String to canonical standard form.
`static boolean`	`compareFsLikePattern(String str, String pattern)` Use * at the beginning or/and the end and a ! at the beginning for 'not'.
`static boolean`	`compareRegexPattern(String str, String pattern)`
`static boolean`	`compareSQLLikePattern(String str, String pattern)` Use % at the beginning and/or the end example: %aloa% or !%aloa%
`static String`	`condense(String s)` Collapse multiple spaces in string down to a single space.
`static int`	`countCharacters(String in, char c)` Return the count of the character in the string.
`static int`	`countCharacters(String in, char[] c)` Return the count of the characters in the string.
`static int`	`countLeading(String text, char c)` count of how many leading characters there are on a string matching a given character.
`static int`	`countTrailing(String text, char c)` count of how many trailing characters there are on a string matching a given character.
`static String`	`decodeCSV(String _field)`
`static String`	`decodeUnicode(String _in)`
`static String`	`decodeURIComponent(String _in)`
`static String`	`encodeCSV(String _field)`
`static String`	`encodeCSVLine(String[] _fields)`
`static String`	`encodeUnicode(String _in)`
`static String`	`encodeURIComponent(String _in)`
`static String`	`encodeWebUnicode(String _in)` Encodes for the web.
`static boolean`	`equals(String in1, String in2)`
`static String`	`findInitials(String title, boolean upperOnly, boolean digits, int maxSize)` Try to find initials out of the given title.
`static String`	`getPart(String value, int nr)`
`static String`	`getPart(String value, int nr, String def)` Split the string in n parts and return the part number nr.
`static String`	`getPart(String value, String separator, int nr)`
`static String`	`getPart(String value, String separator, int nr, String def)`
`static String`	`getRepeatig(int amount, char fill)` Repeate the character a given times.
`static int[]`	`getSelectedPart(String text, int caretPosition)` Search in a string the selected paragraph indicated be empty lines.
`static int[]`	`getSelectedPart(String text, int caretPosition, String[] separators)`
`static String`	`getSelection(String text, int[] part, String def)` Returns the string part of the selected part.
`static int`	`indexOf(String _s, char[] _c)` Returns the position where the first of one of the chars is found in the string.
`static int`	`indexOf(String _s, char[] _c, int offset)` Returns the position where the first of one of the chars is found in the string.
`static boolean`	`isEmpty(String _in)` Returns true if the string is null or an empty string.
`static boolean`	`isEmptyTrim(String s)` Is this string empty?
`static boolean`	`isIndex(String _s, char _c)` Return, if the char is located in the string (indexOf).
`static boolean`	`isIndex(String _s, char[] _c)` Returns true if one of the chars is found in the string.
`static boolean`	`isLegal(String candidate, String legalChars)` Ensure the string contains only legal characters
`static boolean`	`isSet(String _in)` Return true if the the string is not empty.
`static boolean`	`isSetTrim(String _in)` Return true if the the string is not empty also trimmed.
`static boolean`	`isUnaccentedLowerCase(char c)` Check if char is plain ASCII lower case.
`static boolean`	`isUnaccentedUpperCase(char c)` Check if char is plain ASCII upper case.
`static boolean`	`isUnicode(String _in, char _joker)`
`static boolean`	`isWhitespace(char c)` Return true if the character is in the list of whitespaces.
`static String`	`join(Iterator<String> src, String glue)`
`static String`	`join(String[] src, char glue)`
`static String`	`leftPad(String s, int newLen, boolean chop)` Pads the string out to the given length by applying blanks on the left.
`static long`	`parseDirtyLong(String numStr)` convert a String to a long.
`static long`	`parseLongPennies(String numStr)` convert a String into long pennies.
`static String`	`penniesToString(long pennies)` Print dollar currency, stored internally as scaled int.
`static int`	`pluck(String s)` Extracts a number from a string, returns 0 if malformed.
`static String`	`rep(char c, int count)` Produce a String of a given repeating character.
`static void`	`replaceAll(StringBuffer _src, String _pattern, String _replacement)` Replace all pattern thru replacement strings.
`static String`	`replaceAll(String _src, String _pattern, String _replacement)` Replace all pattern thru replacement strings.
`static String`	`replaceSelection(String text, int[] part, String replacement)` Replace a text in another text.
`static String`	`replaceSQLLikePattern(String str, String pattern, String replace)`
`static String`	`rightPad(String s, int newLen, boolean chop)` Pads the string out to the given length by applying blanks on the right.
`static String[]`	`split(String _in, String _pattern)` Split the string in parts.
`static String[]`	`splitIgnoreEmpty(String _in, String _pattern)` Split the string in parts.
`static String[]`	`splitIgnoreEmpty(String _in, String _pattern, boolean trim)`
`static String`	`squish(String s)` Remove all spaces from a String.
`static String`	`toBookTitleCase(String s)` convert to Book Title case, with first letter of each word capitalised.
`static String`	`toHexString(int h)` Convert int to hex with lead zeroes
`static String`	`toLZ(int i, int len)` Convert an integer to a String, with left zeroes.
`static String`	`toString(Color c)` Get #ffffff html hex number for a colour
`static String`	`trimLeading(String s)` Removes white space from beginning this string.
`static String`	`trimTrailing(String s)` Removes white space from end this string.
`static String`	`truncate(String in, int length)` This will truncate the string at the end.
`static String`	`truncateNice(String in, int length)` This will truncate the string, but it also adds three dots (...) at the removed position.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHARSET_UTF_8
```
public static final String CHARSET_UTF_8
```
    See Also:
    Constant Field Values
  - CHARSET_UTF_16
```
public static final String CHARSET_UTF_16
```
    See Also:
    Constant Field Values
  - CHARSET_ISO_8859_1
```
public static final String CHARSET_ISO_8859_1
```
    See Also:
    Constant Field Values
  - WHITESPACE
```
public static final char[] WHITESPACE
```
  - DEFAULT_SEPARATOR
```
public static final String DEFAULT_SEPARATOR
```
    See Also:
    Constant Field Values
  - CHARSET_DEFAULT
```
public static final String CHARSET_DEFAULT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - MString
```
public MString()
```
- Method Detail
  - isSetTrim
```
public static boolean isSetTrim(String _in)
```
    Return true if the the string is not empty also trimmed.
    
    Parameters:
    _in - The string to test
    
    Returns:
    true if the string is not null and not an empty string and not only contains whitespaces
  - isSet
```
public static boolean isSet(String _in)
```
    Return true if the the string is not empty.
    
    Parameters:
    _in - The string to test
    
    Returns:
    true if the string is not null and not an empty string
  - isEmpty
```
public static boolean isEmpty(String _in)
```
    Returns true if the string is null or an empty string.
    
    Parameters:
    _in -
    
    Returns:
  - split
```
public static String[] split(String _in,
             String _pattern)
```
    Split the string in parts. Separator is a pattern. In difference of the build in split it will not remove empty parts and the pattern is not a regex.
    
    Parameters:
    _in -
    _pattern -
    
    Returns:
  - splitIgnoreEmpty
```
public static String[] splitIgnoreEmpty(String _in,
                        String _pattern)
```
    Split the string in parts. Separator is a pattern. In difference of the build in the pattern is not a regex.
    
    Parameters:
    _in -
    _pattern -
    
    Returns:
  - splitIgnoreEmpty
```
public static String[] splitIgnoreEmpty(String _in,
                        String _pattern,
                        boolean trim)
```
  - replaceAll
```
public static String replaceAll(String _src,
                String _pattern,
                String _replacement)
```
    Replace all pattern thru replacement strings. Pattern is not a regex.
    
    Parameters:
    _src -
    _pattern -
    _replacement -
    
    Returns:
  - replaceAll
```
public static void replaceAll(StringBuffer _src,
              String _pattern,
              String _replacement)
```
    Replace all pattern thru replacement strings. Pattern is not a regex.
    
    Parameters:
    _src -
    _pattern -
    _replacement -
  - isIndex
```
public static boolean isIndex(String _s,
              char _c)
```
    Return, if the char is located in the string (indexOf).
  - beforeIndex
```
public static String beforeIndex(String _s,
                 char _c)
```
    Return the string before _c in _s. If _c is not found in _s, return is an empty string.
  - afterIndex
```
public static String afterIndex(String _s,
                char _c)
```
    Return the string after _c in _s. If _c is not found in _s, return is an empty string.
  - isIndex
```
public static boolean isIndex(String _s,
              char[] _c)
```
    Returns true if one of the chars is found in the string.
    
    Parameters:
    _s -
    _c -
    
    Returns:
  - beforeIndex
```
public static String beforeIndex(String _s,
                 char[] _c)
```
    Return the string before _c in _s. If _c is not found in _s, return is an empty string.
  - afterIndex
```
public static String afterIndex(String _s,
                char[] _c)
```
    Return the string after _c in _s. If _c is not found in _s, return is an empty string.
  - indexOf
```
public static int indexOf(String _s,
          char[] _c,
          int offset)
```
    Returns the position where the first of one of the chars is found in the string.
    
    Parameters:
    _s -
    _c -
    offset -
    
    Returns:
  - indexOf
```
public static int indexOf(String _s,
          char[] _c)
```
    Returns the position where the first of one of the chars is found in the string.
    
    Parameters:
    _s -
    _c -
    
    Returns:
  - encodeWebUnicode
```
public static String encodeWebUnicode(String _in)
```
    Encodes for the web. Same like MXml.encode
    
    Parameters:
    _in -
    
    Returns:
  - isUnicode
```
public static boolean isUnicode(String _in,
                char _joker)
```
  - encodeUnicode
```
public static String encodeUnicode(String _in)
```
  - encodeURIComponent
```
public static String encodeURIComponent(String _in)
```
  - decodeUnicode
```
public static String decodeUnicode(String _in)
```
  - decodeURIComponent
```
public static String decodeURIComponent(String _in)
```
  - encodeCSVLine
```
public static String encodeCSVLine(String[] _fields)
```
  - encodeCSV
```
public static String encodeCSV(String _field)
```
  - decodeCSV
```
public static String decodeCSV(String _field)
```
  - compareRegexPattern
```
public static boolean compareRegexPattern(String str,
                          String pattern)
```
  - compareSQLLikePattern
```
public static boolean compareSQLLikePattern(String str,
                            String pattern)
```
    Use % at the beginning and/or the end example: %aloa% or !%aloa%
    
    Parameters:
    str -
    pattern -
    
    Returns:
  - compareFsLikePattern
```
public static boolean compareFsLikePattern(String str,
                           String pattern)
```
    Use * at the beginning or/and the end and a ! at the beginning for 'not'. e.g. *aloa* !*aloa*
    
    Parameters:
    str -
    pattern -
    
    Returns:
  - replaceSQLLikePattern
```
public static String replaceSQLLikePattern(String str,
                           String pattern,
                           String replace)
```
  - join
```
public static String join(String[] src,
          char glue)
```
  - join
```
public static String join(Iterator<String> src,
          String glue)
```
  - canonical
```
public static String canonical(String s)
```
    Convert String to canonical standard form. null -> "". Trims lead trail blanks.
    
    Parameters:
    s - String to be converted.
    
    Returns:
    String in canonical form.
  - condense
```
public static String condense(String s)
```
    Collapse multiple spaces in string down to a single space. Remove lead and trailing spaces.
    
    Parameters:
    s - String to strip of blanks.
    
    Returns:
    String with all blanks, lead/trail/embedded removed.
  - countLeading
```
public static int countLeading(String text,
               char c)
```
    count of how many leading characters there are on a string matching a given character. It does not remove them.
    
    Parameters:
    text - text with possible leading characters, possibly empty, but not null.
    c - the leading character of interest, usually ' ' or '\n'
    
    Returns:
    count of leading matching characters, possibly 0.
  - countTrailing
```
public static int countTrailing(String text,
                char c)
```
    count of how many trailing characters there are on a string matching a given character. It does not remove them.
    
    Parameters:
    text - text with possible trailing characters, possibly empty, but not null.
    c - the trailing character of interest, usually ' ' or '\n'
    
    Returns:
    count of trailing matching characters, possibly 0.
  - isEmptyTrim
```
public static boolean isEmptyTrim(String s)
```
    Is this string empty?
    
    Parameters:
    s - String to be tested for emptiness.
    
    Returns:
    true if the string is null or equal to the "" null string. or just blanks
  - isLegal
```
public static boolean isLegal(String candidate,
              String legalChars)
```
    Ensure the string contains only legal characters
    
    Parameters:
    candidate - string to test.
    legalChars - characters than are legal for candidate.
    
    Returns:
    true if candidate is formed only of chars from the legal set.
  - isUnaccentedLowerCase
```
public static boolean isUnaccentedLowerCase(char c)
```
    Check if char is plain ASCII lower case.
    
    Parameters:
    c - char to check
    
    Returns:
    true if char is in range a..z
    See Also:
    Character.isLowerCase(char)
  - isUnaccentedUpperCase
```
public static boolean isUnaccentedUpperCase(char c)
```
    Check if char is plain ASCII upper case.
    
    Parameters:
    c - char to check.
    
    Returns:
    true if char is in range A..Z.
    See Also:
    Character.isUpperCase(char)
  - leftPad
```
public static String leftPad(String s,
             int newLen,
             boolean chop)
```
    Pads the string out to the given length by applying blanks on the left.
    
    Parameters:
    s - String to be padded/chopped.
    newLen - length of new String desired.
    chop - true if Strings longer than newLen should be truncated to newLen chars.
    
    Returns:
    String padded on left/chopped to the desired length.
  - parseDirtyLong
```
public static long parseDirtyLong(String numStr)
```
    convert a String to a long. The routine is very forgiving. It ignores invalid chars, lead trail, embedded spaces, decimal points etc. Dash is treated as a minus sign.
    
    Parameters:
    numStr - String to be parsed.
    
    Returns:
    long value of String with junk characters stripped.
    
    Throws:
    
    NumberFormatException - if the number is too big to fit in a long.
  - parseLongPennies
```
public static long parseLongPennies(String numStr)
```
    convert a String into long pennies. It ignores invalid chars, lead trail, embedded spaces. Dash is treated as a minus sign. 0 or 2 decimal places are permitted.
    
    Parameters:
    numStr - String to be parsed.
    
    Returns:
    long pennies.
    
    Throws:
    
    NumberFormatException - if the number is too big to fit in a long.
  - penniesToString
```
public static String penniesToString(long pennies)
```
    Print dollar currency, stored internally as scaled int. convert pennies to a string with a decorative decimal point.
    
    Parameters:
    pennies - long amount in pennies.
    
    Returns:
    amount with decorative decimal point, but no lead $.
  - pluck
```
public static int pluck(String s)
```
    Extracts a number from a string, returns 0 if malformed.
    
    Parameters:
    s - String containing the integer.
    
    Returns:
    binary integer.
  - rep
```
public static String rep(char c,
         int count)
```
    Produce a String of a given repeating character.
    
    Parameters:
    c - the character to repeat
    count - the number of times to repeat
    
    Returns:
    String, e.g. rep('*',4) returns "****"
  - rightPad
```
public static String rightPad(String s,
              int newLen,
              boolean chop)
```
    Pads the string out to the given length by applying blanks on the right.
    
    Parameters:
    s - String to be padded/chopped.
    newLen - length of new String desired.
    chop - true if Strings longer than newLen should be truncated to newLen chars.
    
    Returns:
    String padded on left/chopped to the desired length.
  - squish
```
public static String squish(String s)
```
    Remove all spaces from a String.
    
    Parameters:
    s - String to strip of blanks.
    
    Returns:
    String with all blanks, lead/trail/embedded removed.
  - toBookTitleCase
```
public static String toBookTitleCase(String s)
```
    convert to Book Title case, with first letter of each word capitalised. e.g. "handbook to HIGHER consciousness" -> "Handbook to Higher Consciousness" e.g. "THE HISTORY OF THE U.S.A." -> "The History of the U.S.A." e.g. "THE HISTORY OF THE USA" -> "The History of the Usa" (sorry about that.) Don't confuse this with Character.isTitleCase which concerns ligatures.
    
    Parameters:
    s - String to convert. May be any mixture of case.
    
    Returns:
    String with each word capitalised, except embedded words "the" "of" "to"
  - toHexString
```
public static String toHexString(int h)
```
    Convert int to hex with lead zeroes
    
    Parameters:
    h - number you want to convert to hex
    
    Returns:
    0x followed by unsigned hex 8-digit representation
    See Also:
    toString(Color)
  - toLZ
```
public static String toLZ(int i,
          int len)
```
    Convert an integer to a String, with left zeroes.
    
    Parameters:
    i - the integer to be converted
    len - the length of the resulting string. Warning. It will chop the result on the left if it is too long.
    
    Returns:
    String representation of the int e.g. 007
  - toString
```
public static String toString(Color c)
```
    Get #ffffff html hex number for a colour
    
    Parameters:
    c - Color object whose html colour number you want as a string
    
    Returns:
    # followed by 6 hex digits
    See Also:
    toHexString(int)
  - trimLeading
```
public static String trimLeading(String s)
```
    Removes white space from beginning this string.
    All characters that have codes less than or equal to '\u0020' (the space character) are considered to be white space.
    
    Parameters:
    s - String to process. As always the original in unchanged.
    
    Returns:
    this string, with leading white space removed
  - trimTrailing
```
public static String trimTrailing(String s)
```
    Removes white space from end this string.
    All characters that have codes less than or equal to '\u0020' (the space character) are considered to be white space.
    
    Parameters:
    s - String to process. As always the original in unchanged.
    
    Returns:
    this string, with trailing white space removed
  - equals
```
public static boolean equals(String in1,
             String in2)
```
  - getPart
```
public static String getPart(String value,
             int nr,
             String def)
```
    Split the string in n parts and return the part number nr. If the part is not found the default value will be returned.
    
    Parameters:
    name -
    def -
    index -
    subset -
    
    Returns:
  - getPart
```
public static String getPart(String value,
             int nr)
```
  - getPart
```
public static String getPart(String value,
             String separator,
             int nr,
             String def)
```
  - getPart
```
public static String getPart(String value,
             String separator,
             int nr)
```
  - beforeLastIndex
```
public static String beforeLastIndex(String string,
                     char c)
```
    Return part before last occurrence of the char. If the char is not found it will return the hole string.
    
    Parameters:
    string -
    c -
    
    Returns:
  - afterLastIndex
```
public static String afterLastIndex(String string,
                    char c)
```
    Return the part after the last occurrence of the char. If the char is not found it will return the hole string.
    
    Parameters:
    string -
    c -
    
    Returns:
  - truncate
```
public static String truncate(String in,
              int length)
```
    This will truncate the string at the end. If the string is shorter as length it returns the string itself.
    
    Parameters:
    in - String to truncate
    length - Max length of the string
    
    Returns:
    truncated string
  - truncateNice
```
public static String truncateNice(String in,
                  int length)
```
    This will truncate the string, but it also adds three dots (...) at the removed position. The truncation is not at the end at all. The resulted string is a nice representation of the original input. Use this function to display a truncated string. abc...xyz
    
    Parameters:
    in - String to truncate
    length - Max length of the string
    
    Returns:
    truncated string
  - getSelectedPart
```
public static int[] getSelectedPart(String text,
                    int caretPosition)
```
    Search in a string the selected paragraph indicated be empty lines. If the caret position outside the string it will return null.
    
    Parameters:
    text - The string, must not be null
    caretPosition - Position of the caret.
    
    Returns:
    the position or null if the input string is null. Return is int[] {start, end}
  - getSelectedPart
```
public static int[] getSelectedPart(String text,
                    int caretPosition,
                    String[] separators)
```
  - getSelection
```
public static String getSelection(String text,
                  int[] part,
                  String def)
```
    Returns the string part of the selected part. If the part position is outside the bounds of the string it will be trimmed. If the part position is not correct or the returned string is empty then the default string is returned. Good values for the default are null or an empty string. Use this method with the result of getSelectedPart()
    
    Parameters:
    text - The text to crop
    part - The position in the text, first element is the begin second element the end of the selection.
    def - Return this if a selection is not possible.
    
    Returns:
    The selected part of the text.
  - replaceSelection
```
public static String replaceSelection(String text,
                      int[] part,
                      String replacement)
```
    Replace a text in another text.
    
    Parameters:
    text -
    part -
    replacement -
    
    Returns:
  - appendRepeating
```
public static void appendRepeating(int amount,
                   char fill,
                   StringBuffer buffer)
```
    Append the number of times a character to a string buffer.
    
    Parameters:
    amount - number of repeatings
    fill - char to fill
    buffer - target
  - getRepeatig
```
public static String getRepeatig(int amount,
                 char fill)
```
    Repeate the character a given times.
    
    Parameters:
    amount - number of repeatings
    fill - char to fill
    
    Returns:
  - isWhitespace
```
public static boolean isWhitespace(char c)
```
    Return true if the character is in the list of whitespaces.
    
    Parameters:
    c -
    
    Returns:
  - countCharacters
```
public static int countCharacters(String in,
                  char c)
```
    Return the count of the character in the string.
    
    Parameters:
    in -
    c -
    
    Returns:
    count of chars or 0 if 'in' is null
  - countCharacters
```
public static int countCharacters(String in,
                  char[] c)
```
    Return the count of the characters in the string.
    
    Parameters:
    in -
    c -
    
    Returns:
    count of chars or 0 if 'in' is null
  - findInitials
```
public static String findInitials(String title,
                  boolean upperOnly,
                  boolean digits,
                  int maxSize)
```
    Try to find initials out of the given title. Use the first letters after whitspaces for the initials. The returned string is not in upper letters. If you need Upper Letters append toUpper().
    
    Parameters:
    title - The input String
    upperOnly - Set true if only collect upper characters in title
    digits - Set true if digits (after whitespaces) should also be used.
    maxSize - Max size in characters of the initilas or 0 for no limit.
    
    Returns:
    The initials in mixed letters.

Class MString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CHARSET_UTF_8

CHARSET_UTF_16

CHARSET_ISO_8859_1

WHITESPACE

DEFAULT_SEPARATOR

CHARSET_DEFAULT

Constructor Detail

MString

Method Detail

isSetTrim

isSet

isEmpty

split

splitIgnoreEmpty

splitIgnoreEmpty

replaceAll

replaceAll

isIndex

beforeIndex

afterIndex

isIndex

beforeIndex

afterIndex

indexOf

indexOf

encodeWebUnicode

isUnicode

encodeUnicode

encodeURIComponent

decodeUnicode

decodeURIComponent

encodeCSVLine

encodeCSV

decodeCSV

compareRegexPattern

compareSQLLikePattern

compareFsLikePattern

replaceSQLLikePattern

join

join

canonical

condense

countLeading

countTrailing

isEmptyTrim

isLegal

isUnaccentedLowerCase

isUnaccentedUpperCase

leftPad

parseDirtyLong

parseLongPennies

penniesToString

pluck

rep

rightPad

squish

toBookTitleCase

toHexString

toLZ

toString

trimLeading

trimTrailing

equals

getPart

getPart

getPart

getPart

beforeLastIndex

afterLastIndex

truncate

truncateNice

getSelectedPart

getSelectedPart

getSelection