StringTool (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.toolkit.StringTool

All Implemented Interfaces:

Serializable
```
public class StringTool
extends Object
implements Serializable
```
A collection of useful methods for manipulating Strings.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StringTool()

Constructors
Constructor and Description
`StringTool()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`AllInRange(int x, int y, String theString)`
`static String`	`allTrim(String holder)` Lose the whitespace at the end of strings...
`static String`	`arrayToString(Object[] objs)` convert an Array to a String representation of its objects
`static String`	`convertDatePatternFromExcelToStringFormatter(String pattern)`
`static String`	`convertDBtoJavaStyleConvention(String name)` converts underscored DB-style naming convention to java member naming convention
`static String`	`convertFilenameToJSPName(String name)` converts underscored DB-style naming convention to java member naming convention
`static String`	`convertHTML(String rep)` replace endoded text with normal text ie: "&" is converted to "&" check out the w3 list of XML characters
`static String`	`convertJavaStyletoDBConvention(String name)` converts java member naming convention to underscored DB-style naming convention ie: take upperCamelCase and turn into upper_camel_case
`static String`	`convertJavaStyletoFriendlyConvention(String name)` converts java member naming convention to underscored DB-style naming convention ie: take upperCamelCase and turn into upper_camel_case
`static String`	`convertPatternExtractBracketedExpression(String pattern)` extract info, if any, from bracketed expressions within Excel custom number formats
`static String`	`convertPatternFromExcelToStringFormatter(String pattern, boolean isNegative)` converts an excel-style custom format to String.format custom format i.e.
`static String`	`convertXMLChars(String rep)` replace illegal XML characters with their html counterparts ie: "&" is converted to "&" check out the w3 list of XML characters
`static String`	`dbencode(String holder)`
`static double`	`getApproximateCharWidth(Font f, Character c)` return the approximate witdth in width in pixels of the given character
`static double`	`getApproximateHeight(Font f, String s, double w)` return the approximate height it takes to display the given string in the given font in the given width
`static double`	`getApproximateStringWidth(Font f, String s)` given a string, return the maximum of the width in pixels in the given the awt Font.
`static double`	`getApproximateStringWidthLB(Font f, String s)` given a string, return the maximum of the width in pixels in the given the awt Font Observing Line Breaks.
`static String`	`getCompressedUnicode(byte[] input)` get compressed UNICODE string from uncompressed string
`static String`	`getGetMethodNameFromVar(String thismember)` generate a "getXXXX" string from a field name per Extentech java naming conventions.
`static String`	`getLowerCaseFirstLetter(String thismember)`
`static String`	`getPath(String filePath)` strips the path portion from a filepath and returns it
`static String`	`getSetMethodNameFromVar(String thismember)` generate a "setXXXX" string from a field name per Extentech java naming conventions.
`static String`	`getTextBetweenDelims(String originalText, String beginDelim, String endDelim)` This method will retrieve the first instance of text between any two given patterns.
`static String`	`getTextBetweenNestedDelims(String originalText, String beginDelim, String endDelim)` This method will retrieve the first instance of text between any two given patterns.
`static String[]`	`getTokensUsingDelim(String instr, String token)` Basically a String tokenizer
`static String`	`getUpperCaseFirstLetter(String thismember)`
`static String`	`getVarNameFromGetMethod(String thismethod)` get the variable name for a "getXXXX" a field name per JavaBean java naming conventions.
`static void`	`main(String[] args)`
`static String`	`makeDelimitedList(Object[] list, String delimiter)` Each object in the array must support the .toString() method, as it will be used to render the object to its string representation.
`static String`	`proper(String name)` converts strings to "proper" capitalization ie: take "mr.
`static String`	`qualifyFilePath(String fPath)` returns file path fPath qualified with an ending slash
`static String`	`qualifyPatternString(String pattern)` qualifies a pattern string to make valid for applying the pattern
`static String`	`readString(Reader reader)` Reads from a `Reader` into a `String`.
`static String`	`replaceChars(String theFilter, String theString, String replacement)`
`static String`	`replaceExtension(String filepath, String ext)` replaces the extension of a filepath with an new extension
`static String`	`replaceSection(String originalText, String replaceBegin, String replacementText, String replaceEnd)` This method will replace any instance of given text within another string.
`static String`	`replaceText(String theString, String theFilter, String replacement)` replace a section of text based on pattern match throughout string.
`static String`	`replaceText(String originalText, String replaceText, String replacementText, int offset)` Replaces an occurence of String B with String C within String A.
`static String`	`replaceText(String originalText, String replaceText, String replacementText, int offset, boolean skipmatch)` Replaces an occurence of String B with String C within String A.
`static String`	`replaceTokenFromArray(String replace, String token, String[] vals)` Replaces a specified token in a string with a value from the passed through array this is done in matching order from String to Arrray.
`static String`	`rTrim(String originalText)` Trims whitespace from the right side of strings.
`static String[]`	`splitFilepath(String filePath)` splits a filepath into directory and filename
`static String[]`	`splitString(String value, String delimeter)` Returns an array of strings from a single string, similar to String.split() in JavaScript
`static String`	`stackTraceToString(Throwable target)` Returns the given throwable's stack trace as a string.
`static String`	`strip(String tostrip, char stripchar)` Strips all occurences of a character from a given string.
`static String`	`strip(String tostrip, String stripstr)` Strips all occurences of a string from a given string.
`static String`	`StripChars(String theFilter, String theString)`
`static String`	`stripHTML(String rep)` strip out all most HTML tags
`static String`	`stripMatch(String pattern, String matchstr)` If the string matches any part of the pattern, strip the pattern from the string.
`static String`	`stripPath(String filePath)` strips the path portion from a filepath and returns the filename
`static String`	`stripTrailingSpaces(String s)` strip trailing spaces
`static String`	`UseOnlyChars(String theFilter, String theString)`

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

- Constructor Detail
  - StringTool
```
public StringTool()
```
- Method Detail
  - convertXMLChars
```
public static String convertXMLChars(String rep)
```
    replace illegal XML characters with their html counterparts ie: "&" is converted to "&" check out the w3 list of XML characters
    
    Parameters:
    
    rep -
    
    Returns:
  - main
```
public static void main(String[] args)
```
  - stripHTML
```
public static String stripHTML(String rep)
```
    strip out all most HTML tags
    
    Parameters:
    
    rep -
    
    Returns:
    
    a string stripped of all html tags
  - convertHTML
```
public static String convertHTML(String rep)
```
    replace endoded text with normal text ie: "&" is converted to "&" check out the w3 list of XML characters
    
    Parameters:
    
    rep -
    
    Returns:
  - stripMatch
```
public static String stripMatch(String pattern,
                                String matchstr)
```
    If the string matches any part of the pattern, strip the pattern from the string.
  - getVarNameFromGetMethod
```
public static String getVarNameFromGetMethod(String thismethod)
```
    get the variable name for a "getXXXX" a field name per JavaBean java naming conventions. ie: Converts "getFirstName" to "firstName"
  - convertJavaStyletoDBConvention
```
public static String convertJavaStyletoDBConvention(String name)
```
    converts java member naming convention to underscored DB-style naming convention ie: take upperCamelCase and turn into upper_camel_case
  - convertJavaStyletoFriendlyConvention
```
public static String convertJavaStyletoFriendlyConvention(String name)
```
    converts java member naming convention to underscored DB-style naming convention ie: take upperCamelCase and turn into upper_camel_case
  - arrayToString
```
public static String arrayToString(Object[] objs)
```
    convert an Array to a String representation of its objects
    
    Parameters:
    
    name -
    
    Returns:
  - stackTraceToString
```
public static final String stackTraceToString(Throwable target)
```
    Returns the given throwable's stack trace as a string.
    
    Parameters:
    
    target - the Throwable whose stack trace should be returned
    
    Returns:
    
    the stack trace of the given Throwable as a String
    
    Throws:
    
    NullPointerException - if target is null
  - proper
```
public static String proper(String name)
```
    converts strings to "proper" capitalization ie: take "mr. fraNK sMITH" and turn into "Mr. Frank Smith"
  - makeDelimitedList
```
public static String makeDelimitedList(Object[] list,
                                       String delimiter)
```
    Each object in the array must support the .toString() method, as it will be used to render the object to its string representation.
  - splitString
```
public static String[] splitString(String value,
                                   String delimeter)
```
    Returns an array of strings from a single string, similar to String.split() in JavaScript
  - getCompressedUnicode
```
public static String getCompressedUnicode(byte[] input)
```
    get compressed UNICODE string from uncompressed string
  - getLowerCaseFirstLetter
```
public static String getLowerCaseFirstLetter(String thismember)
```
  - getSetMethodNameFromVar
```
public static String getSetMethodNameFromVar(String thismember)
```
    generate a "setXXXX" string from a field name per Extentech java naming conventions. ie: Converts "firstName" to "setFirstName"
  - getUpperCaseFirstLetter
```
public static String getUpperCaseFirstLetter(String thismember)
```
  - getGetMethodNameFromVar
```
public static String getGetMethodNameFromVar(String thismember)
```
    generate a "getXXXX" string from a field name per Extentech java naming conventions. ie: Converts "firstName" to "getFirstName"
  - convertDBtoJavaStyleConvention
```
public static String convertDBtoJavaStyleConvention(String name)
```
    converts underscored DB-style naming convention to java member naming convention
  - convertFilenameToJSPName
```
public static String convertFilenameToJSPName(String name)
```
    converts underscored DB-style naming convention to java member naming convention
  - getTokensUsingDelim
```
public static String[] getTokensUsingDelim(String instr,
                                           String token)
```
    Basically a String tokenizer
    
    Parameters:
    
    instr -
    
    token -
    
    Returns:
  - dbencode
```
public static String dbencode(String holder)
```
  - allTrim
```
public static String allTrim(String holder)
```
    Lose the whitespace at the end of strings...
    
    Parameters:
    
    holder - The String that you want stripped.
    
    Returns:
    
    Your stripped string.
  - stripTrailingSpaces
```
public static String stripTrailingSpaces(String s)
```
    strip trailing spaces
  - strip
```
public static String strip(String tostrip,
                           String stripstr)
```
    Strips all occurences of a string from a given string.
    
    Parameters:
    
    tostrip - The String that you want stripped.
    
    stripchar - The char you want stripped from the String.
    
    Returns:
    
    Your stripped string.
  - strip
```
public static String strip(String tostrip,
                           char stripchar)
```
    Strips all occurences of a character from a given string.
    
    Parameters:
    
    tostrip - The String that you want stripped.
    
    stripchar - The char you want stripped from the String.
    
    Returns:
    
    Your stripped string.
  - replaceText
```
public static String replaceText(String originalText,
                                 String replaceText,
                                 String replacementText,
                                 int offset,
                                 boolean skipmatch)
```
    Replaces an occurence of String B with String C within String A. This method is case sensitive. Example: String A = "I am a happy dog."; String A = stringtool.replaceText(A, "happy", "sad", 0); The result is A="I am a sad dog."
    
    Parameters:
    
    originalText - Original text
    
    replaceText - Text to replace.
    
    replacementText - Text to replace with.
    
    offset - offset of replacement within original string.
    
    Returns:
    
    Processed text.
  - replaceText
```
public static String replaceText(String originalText,
                                 String replaceText,
                                 String replacementText,
                                 int offset)
```
    Replaces an occurence of String B with String C within String A. This method is case sensitive. Example: String A = "I am a happy dog."; String A = stringtool.replaceText(A, "happy", "sad", 0); The result is A="I am a sad dog."
    
    Parameters:
    
    originalText - Original text
    
    replaceText - Text to replace.
    
    replacementText - Text to replace with.
    
    offset - offset of replacement within original string.
    
    Returns:
    
    Processed text.
  - rTrim
```
public static String rTrim(String originalText)
```
    Trims whitespace from the right side of strings.
    
    Parameters:
    
    originalText - Text to trim.
    
    Returns:
    
    Trimmed text.
  - getTextBetweenNestedDelims
```
public static String getTextBetweenNestedDelims(String originalText,
                                                String beginDelim,
                                                String endDelim)
```
    This method will retrieve the first instance of text between any two given patterns. This method is case sensitive. Example: String A = "I am a happy dog."; B = getTextBetweenDelims(A,"a","."); B is now equal to "m a happy dog". C declines comment.
    
    Parameters:
    
    originalText - Text to process.
    
    beginDelim - Delimeter for beginning of retrieved section.
    
    endDelim - Delimeter for end of retrieved section.
    
    Returns:
    
    Text between delims or "" if not found.
  - getTextBetweenDelims
```
public static String getTextBetweenDelims(String originalText,
                                          String beginDelim,
                                          String endDelim)
```
    This method will retrieve the first instance of text between any two given patterns. This method is case sensitive. Example: String A = "I am a happy dog."; B = getTextBetweenDelims(A,"a","."); B is now equal to "m a happy dog". C declines comment.
    
    Parameters:
    
    originalText - Text to process.
    
    beginDelim - Delimeter for beginning of retrieved section.
    
    endDelim - Delimeter for end of retrieved section.
    
    Returns:
    
    Text between delims or "" if not found.
  - replaceSection
```
public static String replaceSection(String originalText,
                                    String replaceBegin,
                                    String replacementText,
                                    String replaceEnd)
```
    This method will replace any instance of given text within another string. This method is case sensitive. Example: String A = "I am a happy dog."; A = replaceSection(A,"happy","hippie cat", "dog"); A is now equal to "I am a hippie cat.".
    
    Parameters:
    
    originalText - Text to process.
    
    replaceBegin - Beggining pattern of replaced section.
    
    replacementText - Text to replace with.
    
    replaceEnd - End pattern of replaced section.
    
    Returns:
    
    Processed text.
  - StripChars
```
public static String StripChars(String theFilter,
                                String theString)
```
  - UseOnlyChars
```
public static String UseOnlyChars(String theFilter,
                                  String theString)
```
  - replaceChars
```
public static String replaceChars(String theFilter,
                                  String theString,
                                  String replacement)
```
  - replaceText
```
public static String replaceText(String theString,
                                 String theFilter,
                                 String replacement)
```
    replace a section of text based on pattern match throughout string.
  - AllInRange
```
public static boolean AllInRange(int x,
                                 int y,
                                 String theString)
```
  - replaceTokenFromArray
```
public static String replaceTokenFromArray(String replace,
                                           String token,
                                           String[] vals)
```
    Replaces a specified token in a string with a value from the passed through array this is done in matching order from String to Arrray.
  - qualifyFilePath
```
public static String qualifyFilePath(String fPath)
```
    returns file path fPath qualified with an ending slash
    
    Parameters:
    
    fPath -
    
    Returns:
    
    fPath with an ending slash
  - splitFilepath
```
public static String[] splitFilepath(String filePath)
```
    splits a filepath into directory and filename
    
    Parameters:
    
    filePath -
    
    Returns:
  - stripPath
```
public static String stripPath(String filePath)
```
    strips the path portion from a filepath and returns the filename
    
    Parameters:
    
    filePath -
    
    Returns:
  - getPath
```
public static String getPath(String filePath)
```
    strips the path portion from a filepath and returns it
    
    Parameters:
    
    filePath -
    
    Returns:
  - replaceExtension
```
public static String replaceExtension(String filepath,
                                      String ext)
```
    replaces the extension of a filepath with an new extension
    
    Parameters:
    
    filepath - Source FilePaht
    
    ext -
    
    Returns:
  - getApproximateStringWidth
```
public static double getApproximateStringWidth(Font f,
                                               String s)
```
    given a string, return the maximum of the width in pixels in the given the awt Font.
    NOTE: this method does not account for line feeds contained within strings
    
    Parameters:
    
    f - awt Font
    
    s - String to compute
    
    Returns:
    
    double approximate width in pixels
  - getApproximateStringWidthLB
```
public static double getApproximateStringWidthLB(Font f,
                                                 String s)
```
    given a string, return the maximum of the width in pixels in the given the awt Font Observing Line Breaks.
    
    Parameters:
    
    f - awt Font
    
    s - String to compute
    
    Returns:
    
    double approximate width in pixels
  - getApproximateCharWidth
```
public static double getApproximateCharWidth(Font f,
                                             Character c)
```
    return the approximate witdth in width in pixels of the given character
    
    Parameters:
    
    f - awt Font
    
    c - character
    
    Returns:
    
    double approximate width in pixels
  - getApproximateHeight
```
public static double getApproximateHeight(Font f,
                                          String s,
                                          double w)
```
    return the approximate height it takes to display the given string in the given font in the given width
    
    Parameters:
    
    f - java.awt.Font
    
    s - String
    
    w - width in points
    
    Returns:
  - convertPatternFromExcelToStringFormatter
```
public static String convertPatternFromExcelToStringFormatter(String pattern,
                                                              boolean isNegative)
```
    converts an excel-style custom format to String.format custom format i.e. %flags-width-precision-conversion
    NOTE: the pattern should be a single item in the excel-style format i.e.one of the terms in positive;negative;zero;text without semicolon.
    NOTE: the java-specific pattern returned will have the negative formatting (sign, parenthesis ...) and so, when used, the double value must be it's absolute value i.e String.format(pattern, Math.abs(d))
    NOTE: date formats are handled separately. this only applies to number and currency formats
    Excel-style: 0 (zero) Digit placeholder. This code pads the value with zeros to fill the format. # Digit placeholder. This code does not display extra zeros. ? Digit placeholder. This code leaves a space for insignificant zeros but does not display them. . (period) Decimal number. % Percentage. Microsoft Excel multiplies by 100 and adds the % character. , (comma) Thousands separator. A comma followed by a placeholder scales the number by a thousand. E+ E- e+ e- Scientific notation. Text Code Description $ - + / ( ) : space These characters are displayed in the number. To display any other character, enclose the character in quotation marks or precede it with a backslash. \character This code displays the character you specify. "text" This code displays text. This code repeats the next character in the format to fill the column width. Note Only one asterisk per section of a format is allowed. _ (underscore) This code skips the width of the next character. This code is commonly used as "_)" (without the quotation marks) to leave space for a closing parenthesis in a positive number format when the negative number format includes parentheses. This allows the values to line up at the decimal point.
    
    Parameters:
    
    pattern - String format pattern in Excel format
    
    isNegative - true if the source is a negative number
    
    Returns:
  - convertDatePatternFromExcelToStringFormatter
```
public static String convertDatePatternFromExcelToStringFormatter(String pattern)
```
  - convertPatternExtractBracketedExpression
```
public static String convertPatternExtractBracketedExpression(String pattern)
```
    extract info, if any, from bracketed expressions within Excel custom number formats
    
    Parameters:
    
    pattern - String Excel number format
    
    Returns:
    
    String returned number format without the bracketed expression
  - qualifyPatternString
```
public static String qualifyPatternString(String pattern)
```
    qualifies a pattern string to make valid for applying the pattern
    
    Parameters:
    
    pattern -
    
    Returns:
  - readString
```
public static String readString(Reader reader)
                         throws IOException
```
    Reads from a Reader into a String. Blocking reads will be issued to the reader and the results will be concatenated into a string, which will be returned once the reader reports end-of-input.
    
    Parameters:
    
    reader - the Reader from which to read
    
    Returns:
    
    a string containing all characters read from the input
    
    Throws:
    
    IOException

Class StringTool

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringTool

Method Detail

convertXMLChars

main

stripHTML

convertHTML

stripMatch

getVarNameFromGetMethod

convertJavaStyletoDBConvention

convertJavaStyletoFriendlyConvention

arrayToString

stackTraceToString

proper

makeDelimitedList

splitString

getCompressedUnicode

getLowerCaseFirstLetter

getSetMethodNameFromVar

getUpperCaseFirstLetter

getGetMethodNameFromVar

convertDBtoJavaStyleConvention

convertFilenameToJSPName

getTokensUsingDelim

dbencode

allTrim

stripTrailingSpaces

strip

strip

replaceText

replaceText

rTrim

getTextBetweenNestedDelims

getTextBetweenDelims

replaceSection

StripChars

UseOnlyChars

replaceChars

replaceText

AllInRange

replaceTokenFromArray

qualifyFilePath

splitFilepath

stripPath

getPath

replaceExtension

getApproximateStringWidth

getApproximateStringWidthLB

getApproximateCharWidth

getApproximateHeight

convertPatternFromExcelToStringFormatter

convertDatePatternFromExcelToStringFormatter

convertPatternExtractBracketedExpression

qualifyPatternString

readString