OAString (OA Java Code Documentation)

java.lang.Object
- com.viaoa.util.OAString

```
public class OAString
extends Object
```
String helper/utility Class.

See Also:

OAConverter

Field Summary

Fields
Modifier and Type Field and Description

static String FS

static String LoremLipsum

static String NL

static String OtherFileNameChars

Fields
Modifier and Type	Field and Description
`static String`	`FS`
`static String`	`LoremLipsum`
`static String`	`NL`
`static String`	`OtherFileNameChars`

Constructor Summary

Constructors
Constructor and Description

OAString()

Constructors
Constructor and Description
`OAString()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`accept(String value, String chars)` Removes characters from a String that are not valid.
`static String`	`align(String value, int width, boolean bAlignLeft, char charPad)` Aligns a string either left or right to a certain width.
`static String`	`append(String orig, String append)`
`static String`	`append(String orig, String append, String sep)`
`static String`	`colorToHex(Color color)` Converts a color to a String that represents the Hex value.
`static int`	`compare(String s1, String s2)`
`static String`	`concat(String toText, String value)`
`static String`	`concat(String toText, String value, String sepChar)`
`static String`	`concat(String toText, String value, String sepChar, boolean bForce)`
`static String`	`convert(String value, char c, String replace)` Used to replace one value with another within a String.
`static String`	`convert(String line, String search, String replace)` Used to replace one value with another within a String.
`static String`	`convert(String line, String search, String replace, boolean bIgnoreCase)` Used to replace one value with another within a String.
`static String`	`convert(String line, String search, String replace, boolean bIgnoreCase, boolean bFirstOnly, int startPos, int endPos)`
`static String`	`convertFileName(String fileName)` Converts fileName path to correct system file.separator characters.
`static String`	`convertFileName(String fileName, boolean bEndWithSlashChar)` Converts fileName path to correct system file.separator characters.
`static String`	`convertFromHtml(String html)` Convert '&' prefixed html codes to character.
`static String`	`convertHungarian(String value)` Used to convert a String that uses Hungarian notation to a titled, space separated String.
`static String`	`convertIgnoreCase(String line, String search, String replace)` Used to replace one value with another within a String, ignoring case.
`static String`	`convertTextToHTML(String value, boolean bAddHTMLTag)`
`static String`	`convertToAscii(String text)` Make sure that all chars value is <= 127, otherwise convert to a space char
`static String`	`convertToDisplayName(String value)`
`static String`	`convertToHtml(String value)`
`static String`	`convertToHungarian(String value)` Example: "Your Name Test" converts to "YourNameTest" Example: "your name test" converts to "yourNameTest" Example: "Your_name_test" converts to "YourNameTest" Example: "your.name.test" converts to "yourNameTest" first char upper/lower-case is not changed.
`static String`	`convertToHungarian(String value, String sepChars)`
`static String`	`convertToJavaIndentifier(String txt)`
`static String`	`convertToNonNull(String str)`
`static String`	`convertToSHAHash(String input)`
`static String`	`convertToValidPhoneNumber(String phone)` Only allows digits and ' ' characters.
`static String`	`convertToXml(String value)` converts null to "" and does other xml/html conversions for <, > & " '
`static String`	`convertToXML(String value)` converts null to "" and does other xml/html conversions for <, > & " '
`static String`	`convertToXML(String value, boolean bCData)` Convert a String to a valid XML String, using special coding for illegal characters.
`static String`	`convertToXML(String value, boolean bCData, boolean bIsHtml)`
`static String`	`convertToXML(String value, boolean bCData, boolean bIsHtml, boolean bLeaveCRLF)`
`static int`	`count(String str, String sep)` Returns the amount of particular String within a String.
`static String`	`cpp(Class clazz, String... args)`
`static String`	`cpp(String... args)` Short name for createPropertyPath
`static String`	`createDisplayName(String value)`
`static String`	`createPropertyPath(Class clazz, String... args)`
`static String`	`createPropertyPath(String... args)` Used to create a dot separated String, used for property paths.
`static String`	`createRandomString(int min, int max)`
`static String`	`createRandomString(int min, int max, boolean bUseDigits, boolean bUseAlpha, boolean bCapFirstChar)` Returns a string that has random generated characters
`static String`	`csv(String toText, Object value)`
`static int`	`dcount(String str, char sep)`
`static int`	`dcount(String str, String sep)` Used to get a count of the number of values between a separator/delimiter.
`static String`	`decodeIllegalXML(String value)` Convert XML Strings converted with encodeIllegalXML() back to a String.
`static String`	`defaultString(String str)` Convert to a string, if null then it returns ""
`static String`	`defaultString(String str, String strIfNull)` Convert to a string, if null then return strIfNull
`protected static String`	`encodeIllegalXML(char ch, boolean bConvertLTGT)` Encode illegal XML characters with <OAXML#999/> where 999 is character integer value. decodeIllegalXML() is used to convert back to character.
`static String`	`encodeIllegalXML(String value)` Encode/Replace chars that are illegal for XML/HTML with & codes.
`static boolean`	`equals(String s1, String s2)` Case sensitive, compares two String to see if they are equal.
`static boolean`	`equals(String s1, String s2, boolean bIgnoreCase)` Compares two String to see if they are equal.
`static boolean`	`equalsIgnoreCase(String s1, String s2)`
`static String`	`field(String str, char sep, int beg)` Used to retrieve a portion of a String based on a separator value.
`static String`	`field(String str, char sep, int beg, int amt)` Used to retrieve a portion of a String based on a separator value.
`static String`	`field(String str, String sep, int beg)` Used to retrieve a portion of a String based on a separator value.
`static String`	`field(String str, String sep, int beg, int amt)` Used to retrieve a portion of a String based on a separator value.
`static String`	`fmt(String str)` Returns a "non-null" value
`static String`	`fmt(String str, String format)` Used to format/mask Strings using a format/mask String.
`static String`	`format(boolean value, String format)` Calls OAConverter to format boolean to a String.
`static String`	`format(double value, String format)` Used to convert an double to a formatted String, either using OAConverter or OAString.format() param vaule integer to format
`static String`	`format(int value, String format)` Used to convert an integer to a formatted String, either using OAConverter or OAString.format() param vaule integer to format
`static String`	`format(long value, String format)` Calls OAConverter to convert/format number.
`static String`	`format(OADate value)` Calls OAConverter to convert and format OADate.
`static String`	`format(OADateTime value, String format)` Calls OAConverter to convert and format OADateTime.
`static String`	`format(String str, String format)` fmt/format javadoc Used to format/mask Strings using a "Pick like" format/mask String.
`static String`	`getAorAn(String s)`
`static String`	`getBegin(String text, int len)` get first N chars from string.
`static String`	`getClassName(Class c)` Removes the package name
`static Map<String,String>`	`getCSSMap(String style)`
`static String`	`getDirectoryName(String filePath)`
`static String`	`getDisplayName(String value)` Used to convert a String that uses Hungarian notation to a titled, space separated String.
`static String`	`getDummyText(int normal, int min, int max)`
`static String`	`getEnd(String text, int len)` get last N chars from string.
`static String`	`getFileName(String filePath)`
`static String`	`getFirst(String text, int len)`
`static Map<String,String>`	`getHTMLAttributeMap(String htmlTag)`
`static String`	`getJavaIndentifier(String txt)`
`static String`	`getLast(String text, int len)`
`static String`	`getNonNull(String str)`
`static String`	`getPackageName(Class c)` gets package name
`static String`	`getPlural(String s)` Converts a String to plural.
`static String`	`getPossessive(String str)` Converts a String to possissive by adding "'s" or "'".
`static String`	`getRandomString(int min, int max)`
`static String`	`getRandomString(int min, int max, boolean bUseDigits, boolean bUseAlpha, boolean bCapFirstChar)`
`static String`	`getRandomString(int normal, int min, int max)`
`static String`	`getRandomString(int normal, int min, int max, boolean bUseDigits, boolean bUseAlpha, boolean bCapFirstChar)`
`static String`	`getSHAHash(String input)`
`static String`	`getTitle(String s)` Converts first letter in each word to uppercase.
`static String`	`getTitle(String s, String basedOn)`
`static String`	`getTitleCase(String s)` Converts first letter in each word to uppercase.
`static boolean`	`hasDigits(String word)` Returns true if String has any digit characters in it.
`static String`	`hilite(String line, String search)`
`static String`	`hilite(String line, String search, String beginTag, String endTag)`
`static String`	`hilite(String line, String search, String beginTag, String endTag, boolean bIgnoreCase)`
`static String`	`hiliteIgnoreCase(String line, String search, String beginTag, String endTag)`
`static String`	`indent(String text, int amt)`
`static boolean`	`isDate(String s)` Returns true if String is a valid Date.
`static boolean`	`isDateTime(String s)` Returns true if String is a valid DateTime.
`static boolean`	`isEmpty(Object obj)`
`static boolean`	`isEmpty(Object obj, boolean bTrim)`
`static boolean`	`isEqual(String s, String s2)`
`static boolean`	`isEqual(String s, String s2, boolean bIgnoreCase)`
`static boolean`	`isInteger(String str)`
`static boolean`	`isLegalXML(String value)` Used to determine if a String has any illegal XML characters in it.
`static boolean`	`isNotEmpty(Object obj)`
`static boolean`	`isNumber(String str)` Returns true if String is a valid number.
`static boolean`	`isTime(String s)` Returns true if String is a valid Time.
`static String`	`lineBreak_OLD(String origLine, int width, String delim, int maxLines)` Split text into lines, and adding a line seperator between the breaks.
`static String`	`lineBreak(String origLine, int width)` Shorten line to width amount of characters.
`static String`	`lineBreak(String origLine, int width, String delim, int maxLines)` Formats a string to have a max width per line separated by a delimiter.
`static void`	`main(String[] args)`
`static void`	`main2(String[] args)`
`static void`	`main99(String[] args)`
`static void`	`mainB(String[] args)`
`static void`	`mainX(String[] args)`
`static void`	`mainXX(String[] args)`
`static void`	`mainXXx(String[] args)`
`static String`	`makeFirstCharLower(String s)`
`static String`	`makeFirstCharUpper(String s)`
`static String`	`makeFirstUpperCharsLower(String s)` Example: GSMRServer -> gsmrServer
`static String`	`makeJavaIndentifier(String txt)` Converts any non-Java indentifier characters to a '_'
`static String`	`makePlural(String str)` Converts a String to plural.
`static String`	`makePossessive(String str)`
`static String`	`makeSingular(String str)` Converts a String that is plural to singular. Converts end characters: "hes" to "h", "ses" to "s", "zzes" to "zz", "ies" to "y", "s" to "".
`static String`	`mask(String value, String mask)` Used to generate a String based on a mask.
`static String`	`mask(String value, String mask, boolean bRightJustified)` Used to generate a String based on a mask.
`static String`	`mfcl(String s)`
`static String`	`mfcu(String s)`
`static String`	`mfcu(String s, String basedOn)`
`static String`	`mfucl(String s)`
`static boolean`	`notEmpty(Object obj)`
`static String`	`notNull(String s)` Convert to a string, if null then it returns ""
`static String`	`pad(String value, int amount, boolean bAddToEnd, char padCharacter)` Append characters to begin/end of a value.
`static int`	`parseInt(String val)`
`static String[]`	`parseLine(String line, char sep, boolean bCouldHaveQuotes)`
`static String[]`	`parseLine(String line, char sep, boolean bCouldHaveQuotes, int sizeEstimate)` Strips out leading and trailing whitespace for each column.
`static String`	`pickFormat(String str, String format)`
`static String`	`removeCharacters(String line, String search)` Remove any and all search characters from a string.
`static String`	`removeEndingChars(String s, int amt)`
`static String`	`removeNonDigits(String line)` Remove any and all characters that are not digits
`static String`	`removeNonDigits(String line, boolean bAllowDot)`
`static String`	`removeNonFileNameChars(String line)` Remove any and all characters that are not valid in filename.
`static String`	`removeOtherCharacters(String line, String keep)` Remove any and all characters that are not in string
`static String`	`soundex(String word)` Soundex is used for creating a code that is used to find similar words.
`static String`	`strip(String value, String chars)` Removes characters from a String.
`protected static String`	`stripChars(String value, String chars, boolean bKeepChars)` called by strip, accept
`static String`	`stripNumber(String value)` Remove digit characters from String.
`static String`	`substring(String s, int pos1, int pos2)`
`static String`	`titleCase(String s)` Converts first letter in each word to uppercase.
`protected static String[]`	`tokenize(String text, char delimChar, boolean spaceIsDelim, boolean bIncludeDelim, char begChar, char endChar, char eovChar)` This will split a string based on a delimiter char, and will also take into account values that are in single or double quotes.
`static String`	`toNonNull(String str)`
`static String`	`toNumberString(int x)` Convert a number to a string value.
`static String`	`toString(Object obj)`
`static String`	`toString(String str)` Convert to a string, if null then it returns ""
`static String`	`toString(String str, String strIfNull)` Convert to a string, if null then it returns ""
`static String`	`toTitleCase(String s)` Converts first letter in each word to uppercase.
`String`	`toUTF8(String isoString)`
`static String`	`trim(String line)` String trim method. 1: removes leading spaces 2: removes extra spaces within.
`static String`	`trimEndingWhitespace(String text)` Remove ending whitspace from a string.
`static String`	`trimWhitespace(String text)` Removes any leading & trailing whitespace chars, but will leave single space chars within text.
`static String`	`trunc(String orig, int width)` Shorten line to width amount of characters.
`static String`	`truncate(String orig, int width)`
`static String`	`unindent(String text)` remove leading spaces from each line in a string that is separated by '\n'
`static String`	`unindent(String text, boolean bBasedOnFirstLine)`
`static String`	`unindentCode(String text)` Used for removing the extra indent spacing for pasting code.

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

Field Detail

NL
```
public static final String NL
```

FS
```
public static final String FS
```

OtherFileNameChars

public static final String OtherFileNameChars

See Also:: Constant Field Values

LoremLipsum
```
public static final String LoremLipsum
```
See Also:

Constant Field Values

Constructor Detail
- OAString
```
public OAString()
```

Method Detail

trim

public static String trim(String line)

String trim method.
1: removes leading spaces
2: removes extra spaces within. (Note: even if enclosed in quotes)
3: removes trailing spaces

        Example:  "  this    is   a  test  "  will be: "this is a test"

getEnd

public static String getEnd(String text,
                            int len)

get last N chars from string.

Parameters:: len - number of chars to get

getLast

public static String getLast(String text,
                             int len)

getBegin

public static String getBegin(String text,
                              int len)

get first N chars from string.

Parameters:: len - number of chars to get

getFirst

public static String getFirst(String text,
                              int len)

convertToXml
```
public static String convertToXml(String value)
```
converts null to "" and does other xml/html conversions for <, > & " '

See Also:

convertToXML(String,boolean)

convertToHtml

public static String convertToHtml(String value)

convertTextToHTML

public static String convertTextToHTML(String value,
                                       boolean bAddHTMLTag)

convertToXML

public static String convertToXML(String value)

converts null to "" and does other xml/html conversions for <, > & " '

        see: http://www.w3.org/TR/REC-xml#NT-Char

        Legal Chars ::=   #x9 | #xA | #xD | [#x20-#xD7FF] |
                  [#xE000-#xFFFD] | [#x10000-#x10FFFF]

        9, 10, 13
        tab, lf, cr

See Also:: convertToXML(String,boolean)

encodeIllegalXML
```
public static String encodeIllegalXML(String value)
```
Encode/Replace chars that are illegal for XML/HTML with & codes.

See Also:

convertToXML(String,boolean)

encodeIllegalXML
```
protected static String encodeIllegalXML(char ch,
                                         boolean bConvertLTGT)
```
Encode illegal XML characters with <OAXML#999/> where 999 is character integer value.
decodeIllegalXML() is used to convert back to character.
This is used internally by convertToXML

Parameters:

ch - is character to encode

bConvertLTGT - if true then convert < to < and > to >. This is needed when it is not going to be used in a XML CDATA block.

See Also:

decodeIllegalXML(java.lang.String), convertToXML(String,boolean)

convertToXML
```
public static String convertToXML(String value,
                                  boolean bCData)
```
Convert a String to a valid XML String, using special coding for illegal characters.
Converts & to &, " to &quot, ' to &apos, < to &<, > to >
For characters less then 32, it calls encodeIllegalXML().
Note: Some characters are illegal even within CDATA blocks.
NOTE: decodeIllegalXML() should be called to reverse this String, since encodeIllegalXML() uses a special tag.

Parameters:

value - is XML String to convert.

bCData - true if this String will be used in an XML CDATA block.

Returns:

converted string. If value is null then a blank "" is returned.

See Also:

decodeIllegalXML(java.lang.String), encodeIllegalXML(java.lang.String)

convertToXML

public static String convertToXML(String value,
                                  boolean bCData,
                                  boolean bIsHtml)

convertToXML

public static String convertToXML(String value,
                                  boolean bCData,
                                  boolean bIsHtml,
                                  boolean bLeaveCRLF)

isLegalXML
```
public static boolean isLegalXML(String value)
```
Used to determine if a String has any illegal XML characters in it.

Returns:

false if any of the following characters are found: & " \ < > LF CR or char<32. If value is null then false is returned.

decodeIllegalXML
```
public static String decodeIllegalXML(String value)
```
Convert XML Strings converted with encodeIllegalXML() back to a String. Since encodeIllegalXML encodes illegal characters with a <OAXML#99/> code, this method will convert those tags to the actual character.

Returns:

string that was decoded. If value is null then null is returned.

See Also:

encodeIllegalXML(java.lang.String)

convert
```
public static String convert(String value,
                             char c,
                             String replace)
```
Used to replace one value with another within a String.

Parameters:

replace - the string or null that will replace every occurance of the the character "c"

See Also:

convert()

convertIgnoreCase

public static String convertIgnoreCase(String line,
                                       String search,
                                       String replace)

Used to replace one value with another within a String, ignoring case.

Parameters:: replace - the string or null that will replace every occurance of the the search string
See Also:: convert()

convert

public static String convert(String line,
                             String search,
                             String replace)

Used to replace one value with another within a String.

Parameters:: replace - the string or null that will replace every occurance of the the search string
See Also:: convert()

removeCharacters

public static String removeCharacters(String line,
                                      String search)

Remove any and all search characters from a string.

Parameters:: line - original data; search - characters to remove
Returns:

removeOtherCharacters

public static String removeOtherCharacters(String line,
                                           String keep)

Remove any and all characters that are not in string

Parameters:: line - original data param search characters to keep

removeNonDigits
```
public static String removeNonDigits(String line)
```
Remove any and all characters that are not digits

Parameters:

line - original data

removeNonDigits

public static String removeNonDigits(String line,
                                     boolean bAllowDot)

removeNonFileNameChars
```
public static String removeNonFileNameChars(String line)
```
Remove any and all characters that are not valid in filename.

convert
```
public static String convert(String line,
                             String search,
                             String replace,
                             boolean bIgnoreCase)
```
Used to replace one value with another within a String.

Parameters:

line - is String that is to be converted.

search - is String that is to be replaced.

replace - is replacement value to use. If null, then a blank String will be used.

bIgnoreCase - if true, then search is not case sensitive.

Returns:

new String where search String is replaced with replace String. If line is null then null is returned. If search is null then line is returned.

convert

public static String convert(String line,
                             String search,
                             String replace,
                             boolean bIgnoreCase,
                             boolean bFirstOnly,
                             int startPos,
                             int endPos)

getClassName

public static String getClassName(Class c)

Removes the package name

getPackageName

public static String getPackageName(Class c)

gets package name

convertHungarian
```
public static String convertHungarian(String value)
```
Used to convert a String that uses Hungarian notation to a titled, space separated String.
Example: "yourNameTest" converts to "Your Name Test"

Parameters:

value - String to convert

Returns:

new String that is titled case, with spaces to seperate words. If value is null, then a blank "" is returned.

convertToHungarian
```
public static String convertToHungarian(String value)
```
Example: "Your Name Test" converts to "YourNameTest" Example: "your name test" converts to "yourNameTest" Example: "Your_name_test" converts to "YourNameTest" Example: "your.name.test" converts to "yourNameTest" first char upper/lower-case is not changed.

convertToHungarian

public static String convertToHungarian(String value,
                                        String sepChars)

getDisplayName
```
public static String getDisplayName(String value)
```
Used to convert a String that uses Hungarian notation to a titled, space separated String. The first char and all letter chars following non-letter characters will be converted to uppercase. Words will be seperated using space character.
Example: "yourNameTest" converts to "Your Name Test"
Example: "USAmerica" converts to "US America"
Example: "v.via" converts to "V.Via"

Parameters:

value - String to convert

Returns:

new String that is titled case, with spaces to seperate words. If value is null, then a blank "" is returned.

createDisplayName

public static String createDisplayName(String value)

convertToDisplayName

public static String convertToDisplayName(String value)

makeSingular
```
public static String makeSingular(String str)
```
Converts a String that is plural to singular.
Converts end characters: "hes" to "h", "ses" to "s", "zzes" to "zz", "ies" to "y", "s" to "". This is the reverse method of makePlural.

Returns:

new String. If s is null, then a blank "" is returned.

See Also:

makePlural(java.lang.String)

getPlural
```
public static String getPlural(String s)
```
Converts a String to plural.

See Also:

makePlural(java.lang.String)

getAorAn

public static String getAorAn(String s)

makePlural
```
public static String makePlural(String str)
```
Converts a String to plural.
- If str ends in "es" then no change is made.
- If str ends in "s" then add "es".
- If str ends in "zz" then add "s".
- If str ends is an "h", "z", "x" then add "es".
- If str ends in a vowel + "y", then add "s".
- If str ends in a nonvowel + "y", then convert "y" to "ies".
- All others have an "s" added.
Note: case will be matched, whatever characters are appended will match the case of the String. This is the reverse method of makeSingular.
Returns:

new plural String. If s is null, then a blank "" is returned.

See Also:

makeSingular(java.lang.String)

makePossessive

public static String makePossessive(String str)

getPossessive
```
public static String getPossessive(String str)
```
Converts a String to possissive by adding "'s" or "'".

getTitleCase
```
public static String getTitleCase(String s)
```
Converts first letter in each word to uppercase.

Returns:

new String.

toTitleCase
```
public static String toTitleCase(String s)
```
Converts first letter in each word to uppercase.

Returns:

new String.

titleCase
```
public static String titleCase(String s)
```
Converts first letter in each word to uppercase.

Returns:

new String.

mfcl
```
public static String mfcl(String s)
```

makeFirstCharLower

public static String makeFirstCharLower(String s)

mfucl
```
public static String mfucl(String s)
```

makeFirstUpperCharsLower

public static String makeFirstUpperCharsLower(String s)

Example: GSMRServer -> gsmrServer

mfcu
```
public static String mfcu(String s)
```

makeFirstCharUpper

public static String makeFirstCharUpper(String s)

getTitle
```
public static String getTitle(String s)
```
Converts first letter in each word to uppercase.

Returns:

new String.

mfcu

public static String mfcu(String s,
                          String basedOn)

getTitle
```
public static String getTitle(String s,
                              String basedOn)
```
Parameters:

basedOn - is another name that this one should use to figure out which letters to capitalize. ex: gsmrServer, GSMRServer => GSMRServer

field

public static String field(String str,
                           char sep,
                           int beg)

Used to retrieve a portion of a String based on a separator value.

See Also:: field(String,String,int,int)

field

public static String field(String str,
                           char sep,
                           int beg,
                           int amt)

Used to retrieve a portion of a String based on a separator value.

See Also:: field(String,String,int,int)

field

public static String field(String str,
                           String sep,
                           int beg)

Used to retrieve a portion of a String based on a separator value.

See Also:: field(String,String,int,int)

field
```
public static String field(String str,
                           String sep,
                           int beg,
                           int amt)
```
Used to retrieve a portion of a String based on a separator value.

Parameters:

str - String to parse

sep - seperator wihin str

beg - field to find, where first field is 1

amt - number of fields to return, -1 for all after the beg

Returns:

string value of field if begin position exists, else null if not found

dcount
```
public static int dcount(String str,
                         String sep)
```
Used to get a count of the number of values between a separator/delimiter.
Note: even if there is not a value between consective separators, it is still counted as another value - in this case a blank.

Parameters:

str - is String to search. If null or length = 0, then 0 is returned.

sep - separator.

dcount

public static int dcount(String str,
                         char sep)

count
```
public static int count(String str,
                        String sep)
```
Returns the amount of particular String within a String.

Parameters:

str - is String to search within.

sep - is String to search for.

Returns:

number of occurrences of sep.

pad
```
public static String pad(String value,
                         int amount,
                         boolean bAddToEnd,
                         char padCharacter)
```
Append characters to begin/end of a value.

Parameters:

value - is String to append to. If null, then it will be initialized to an empty string.

amount - is number of characters to add.

bAddToEnd - if true, then charPad characters are appended to value, else charPad chars are prefixed to value.

padCharacter - is the character to use for adding to value.

See Also:

align(java.lang.String, int, boolean, char)

align
```
public static String align(String value,
                           int width,
                           boolean bAlignLeft,
                           char charPad)
```
Aligns a string either left or right to a certain width. If length of value is less then width, then characters are added to begin/end of value to make it equal to the width. If length of value is greater then the width, then the beginning/ending width amount of characters will be returned.

Parameters:

value - is String to alter. If null, then it will be initialized to an empty string.

width - is number of characters for the converted string. If <= 0, then a blank string is returned.

bAlignLeft - if true then value is right aligned, else left aligned.

charPad - is the character to use to pad the value, if length of value is less then width. The value will then have this character either at the beginning or ending, depending on value of bAlignLeft.

Returns:

new String that is "width" characters in length.

See Also:

pad(String,int,boolean,char)

format

public static String format(long value,
                            String format)

Calls OAConverter to convert/format number. see OAConverterNumber

format
```
public static String format(int value,
                            String format)
```
Used to convert an integer to a formatted String, either using OAConverter or OAString.format() param vaule integer to format

Parameters:

format - if String has an "L", "R", or "C" in it, then OAString.format(String,String) will be used, else OAConverter.toString() will be called. see OAConverterNumber

See Also:

fmt(String,String)

format
```
public static String format(double value,
                            String format)
```
Used to convert an double to a formatted String, either using OAConverter or OAString.format() param vaule integer to format

Parameters:

format - if String has an "L", "R", or "C" in it, then OAString.format(String,String) will be used, else OAConverter.toString() will be called, which uses Java formatting. see OAConverterNumber

See Also:

fmt(String,String)

format

public static String format(boolean value,
                            String format)

Calls OAConverter to format boolean to a String. see OAConverterBoolean

format

public static String format(OADateTime value,
                            String format)

Calls OAConverter to convert and format OADateTime. see OAConverterOADateTime

format
```
public static String format(OADate value)
```
Calls OAConverter to convert and format OADate. see OAConverterOADate

format

public static String format(String str,
                            String format)

fmt/format javadoc Used to format/mask Strings using a "Pick like" format/mask String.

Also suoports formats for Date/Times (see OADateTime) and Numbers (see OAConverterNumber)

Formatting Strings


        Example:  fmt(str,"12 L2.,$0(MASK)");
        
        Format description for "12 L2,$0(MASK)":
            12 = width - not required. 
                 will pad with spaces if pad character is not defined.
                 if width is not included, then length of String is not restricted.
        ' ' = trailing blanks that will be added to the end of formatted String.
            L = L, R, or C justified
            2 = decimal places - can only be ONE digit.  Rounding will be used.
            . = if value has to be truncated, then "..." will be the last 3 chars.  Only used with "L" justified.
            , = if you want commas to seperate numbers
            $ = dollar sign, only if 'R' justified  puts it in first char
            0 = any pad character - default space. Dont put this 1 after L/R, since
                that position is used for the amount of decimal places.
            Mask = must be in "()".  Use # character to have actual characters inserted,
                   all other characters in mask will be inserted.

        Examples:
        
        fmt("1234.5", "R4,") 
            "R4," = align right, 4 decimal places with comma seperators.
            output: "1,234.5000"  
        
        fmt("123.5", "R00")
            "R00" = align right, 0 decimal places (causes rounding), pad with '0' character
            output: "123"
        
        fmt("123.5", "8R00")
            "8R00" = 8 width to fill, 
            output: "00000123"
        
        fmt("123.5", "8 R00")
            "8 R00" = 8 width, append one space, right justified, 0 decimal places, '0' fill
            output: "00000123 "
        
        fmt("1231231234","13  R((###)###-####)")
            "13  R((###)###-####)" = 13 width, append 2 spaces, right justified, mask to use.
                 Note: the mask must be put into () and use # to denote where to insert the 
                 characters within the supplied String.
            output: "(123)123-1234  "
        fmt("CustomerName", "8L.")
             output: "Custo..."

pickFormat

public static String pickFormat(String str,
                                String format)

fmt

public static String fmt(String str,
                         String format)

Used to format/mask Strings using a format/mask String.

See Also:: format(String,String)

stripNumber
```
public static String stripNumber(String value)
```
Remove digit characters from String.

Parameters:

value - is String to strip.

Returns:

if value=null then null, else new String with digits removed. Note: does not remove "." between digits.

mask
```
public static String mask(String value,
                          String mask)
```
Used to generate a String based on a mask.

Parameters:

value - is String to use with mask.

mask - where all # characters will be replaced by data in value. All other characters (non #) in mask will be outputted with new String.

Returns:

new String with mask applied.

mask
```
public static String mask(String value,
                          String mask,
                          boolean bRightJustified)
```
Used to generate a String based on a mask.

Parameters:

value - is String to use with mask. If null, then value is set to a blank "" String.

mask - where all # characters will be replaced by data in value. All other characters (non #) in mask will be outputted with new String.

bRightJustified - if true, then mask will be generated from right to left, else left to right.

Returns:

new String with mask applied. If mask == null, then value is returned.

strip

public static String strip(String value,
                           String chars)

Removes characters from a String.

Parameters:: value - is String to strip from.; chars - values to remove from value

accept
```
public static String accept(String value,
                            String chars)
```
Removes characters from a String that are not valid.

Parameters:

value - is String to strip from.

chars - is the characters that are valid, other characters will be removed.

stripChars

protected static String stripChars(String value,
                                   String chars,
                                   boolean bKeepChars)

called by strip, accept

convertFileName
```
public static String convertFileName(String fileName)
```
Converts fileName path to correct system file.separator characters.

Returns:

new String with corrected file path characters.

convertFileName
```
public static String convertFileName(String fileName,
                                     boolean bEndWithSlashChar)
```
Converts fileName path to correct system file.separator characters.

Returns:

new String with corrected file path characters.

getFileName

public static String getFileName(String filePath)

getDirectoryName

public static String getDirectoryName(String filePath)

colorToHex
```
public static String colorToHex(Color color)
```
Converts a color to a String that represents the Hex value.

Returns:

null if color=null, else Hex String with leading "#", ex: "#00FFCC"

hasDigits
```
public static boolean hasDigits(String word)
```
Returns true if String has any digit characters in it.

soundex

public static String soundex(String word)

Soundex is used for creating a code that is used to find similar words.

20100417 now using more advanced algorithm see: http://www.archives.gov/genealogy/census/soundex.html

This code is set to 4 char value - padded with char '0'.
If word == NULL then sndx = "0000"

        use first letter
        exclude "AEHIOUWY" or any char that is not a letter
        exclude all duplicates
        '0' pad to 4 chars             Note: this will also use digits

        From: "BFPVCGJKQSZXDTLMNR"
        To  : "111122222222334556"

        EXAMPLE:
        soundex(sndx,"Vincent")  sndx = "V523"
        soundex(sndx,"Via")      sndx = "V000"

Parameters:: word - String to create a soundex code for.
Returns:: new String that is soundex code for word. If word is null,then "0000" is returned.

isNumber
```
public static boolean isNumber(String str)
```
Returns true if String is a valid number. This will try to convert the String to a Double.

Parameters:

str - String to check

Returns:

true if String can be converted to a Double. If str is null then false is returned. see OAConverterNumber

isInteger

public static boolean isInteger(String str)

isDate
```
public static boolean isDate(String s)
```
Returns true if String is a valid Date. This will try to convert the String to a OADate.

Parameters:

s - String to check

Returns:

true if String can be converted to a OADate. see OAConverterOADate

isTime
```
public static boolean isTime(String s)
```
Returns true if String is a valid Time. This will try to convert the String to a OATime.

Parameters:

s - String to check

Returns:

true if String can be converted to a OATime. see OAConverterOATime

isDateTime
```
public static boolean isDateTime(String s)
```
Returns true if String is a valid DateTime. This will try to convert the String to a OADateTime.

Parameters:

s - String to check

Returns:

true if String can be converted to a OADateTime. see OAConverterOADateTime

equals
```
public static boolean equals(String s1,
                             String s2)
```
Case sensitive, compares two String to see if they are equal. This will automatically check for nulls.

Returns:

true if both Strings are equal, including if both are null.

See Also:

equals(String,String,boolean)

equals
```
public static boolean equals(String s1,
                             String s2,
                             boolean bIgnoreCase)
```
Compares two String to see if they are equal. This will automatically check for nulls.

Parameters:

bIgnoreCase - if true, performs a comparision that is case insensitive.

Returns:

true if both Strings are equal, including if both are null.

See Also:

equals(String,String,boolean)

toString

public static String toString(Object obj)

toNumberString
```
public static String toNumberString(int x)
```
Convert a number to a string value. Example: 21 = "21st"

trunc
```
public static String trunc(String orig,
                           int width)
```
Shorten line to width amount of characters. If longer then width, then "..." will be the end.

truncate

public static String truncate(String orig,
                              int width)

lineBreak
```
public static String lineBreak(String origLine,
                               int width)
```
Shorten line to width amount of characters. If longer then width, then "..." will be the end.

lineBreak_OLD

public static String lineBreak_OLD(String origLine,
                                   int width,
                                   String delim,
                                   int maxLines)

Split text into lines, and adding a line seperator between the breaks.

Parameters:: width -; delim, - string to insert at line break; maxLines, - the max amount of lines to create. If longer, then "..." will be added
Returns:

createRandomString

public static String createRandomString(int min,
                                        int max)

getRandomString

public static String getRandomString(int min,
                                     int max)

getRandomString

public static String getRandomString(int normal,
                                     int min,
                                     int max)

createRandomString
```
public static String createRandomString(int min,
                                        int max,
                                        boolean bUseDigits,
                                        boolean bUseAlpha,
                                        boolean bCapFirstChar)
```
Returns a string that has random generated characters

Parameters:

min - minimum amount of chars in the result.

max - maximum amount of chars in the result.

bUseDigits - if true will use chars 0-9

bUseAlpha - if true will use chars a-z

bCapFirstChar - if true and bUseAlpha, then the first char will be capitalized, otherwise all chars will be lowercase.

getRandomString

public static String getRandomString(int min,
                                     int max,
                                     boolean bUseDigits,
                                     boolean bUseAlpha,
                                     boolean bCapFirstChar)

getRandomString

public static String getRandomString(int normal,
                                     int min,
                                     int max,
                                     boolean bUseDigits,
                                     boolean bUseAlpha,
                                     boolean bCapFirstChar)

getDummyText

public static String getDummyText(int normal,
                                  int min,
                                  int max)

cpp
```
public static String cpp(String... args)
```
Short name for createPropertyPath

See Also:

createPropertyPath(String...)

cpp

public static String cpp(Class clazz,
                         String... args)

Parameters:: clazz - name of the first class, in case it is a generic type. (ex: OALeftJoin.A); args -
Returns:

createPropertyPath
```
public static String createPropertyPath(String... args)
```
Used to create a dot separated String, used for property paths.

createPropertyPath
```
public static String createPropertyPath(Class clazz,
                                        String... args)
```
Parameters:

clazz - name of the first class, in case it is a generic type. (ex: OALeftJoin.A)

args - each property used in the property path.

Returns:

a dot separated string that represents a valid property path.

toUTF8

public String toUTF8(String isoString)

getSHAHash

public static String getSHAHash(String input)

convertToSHAHash

public static String convertToSHAHash(String input)

lineBreak
```
public static String lineBreak(String origLine,
                               int width,
                               String delim,
                               int maxLines)
```
Formats a string to have a max width per line separated by a delimiter. Lines are broken by whitespace, '-', '.'

Parameters:

width - max width per line.

delim - inserted into origLine to create line breaks

maxLines - maximum number of lines, if result is longer, then it will be truncated and append with " ..."

mainXX

public static void mainXX(String[] args)

mainX

public static void mainX(String[] args)

notEmpty

public static boolean notEmpty(Object obj)

isNotEmpty

public static boolean isNotEmpty(Object obj)

isEmpty
```
public static boolean isEmpty(Object obj)
```
Returns:

If null, then returns true; if String and length is 0, returns true; if array and length == 0, returns true. all others return false.

See Also:

OACompare.isEmpty(Object)

isEmpty

public static boolean isEmpty(Object obj,
                              boolean bTrim)

isEqual

public static boolean isEqual(String s,
                              String s2)

isEqual

public static boolean isEqual(String s,
                              String s2,
                              boolean bIgnoreCase)

fmt
```
public static String fmt(String str)
```
Returns a "non-null" value

Parameters:

str -

Returns:

"" if str is null, else return str

compare

public static int compare(String s1,
                          String s2)

equalsIgnoreCase

public static boolean equalsIgnoreCase(String s1,
                                       String s2)

convertToValidPhoneNumber
```
public static String convertToValidPhoneNumber(String phone)
```
Only allows digits and ' ' characters. Will left pad with spaces to make 10 char long.

indent

public static String indent(String text,
                            int amt)

unindent
```
public static String unindent(String text)
```
remove leading spaces from each line in a string that is separated by '\n'

Parameters:

text -

bBasedOnFirstLine - if true, then each line will only remove the same leading spaces found in the first line. This is good for code.

unindentCode
```
public static String unindentCode(String text)
```
Used for removing the extra indent spacing for pasting code.

unindent

public static String unindent(String text,
                              boolean bBasedOnFirstLine)

trimEndingWhitespace

public static String trimEndingWhitespace(String text)

Remove ending whitspace from a string.

parseLine

public static String[] parseLine(String line,
                                 char sep,
                                 boolean bCouldHaveQuotes)

parseLine

public static String[] parseLine(String line,
                                 char sep,
                                 boolean bCouldHaveQuotes,
                                 int sizeEstimate)

Strips out leading and trailing whitespace for each column. if bCouldHaveQuotes is true, then begin and end quotes will be removed; either single or double quote char.

mainXXx

public static void mainXXx(String[] args)

trimWhitespace
```
public static String trimWhitespace(String text)
```
Removes any leading & trailing whitespace chars, but will leave single space chars within text.

convertFromHtml
```
public static String convertFromHtml(String html)
```
Convert '&' prefixed html codes to character.

convertToAscii
```
public static String convertToAscii(String text)
```
Make sure that all chars value is <= 127, otherwise convert to a space char

tokenize
```
protected static String[] tokenize(String text,
                                   char delimChar,
                                   boolean spaceIsDelim,
                                   boolean bIncludeDelim,
                                   char begChar,
                                   char endChar,
                                   char eovChar)
```
This will split a string based on a delimiter char, and will also take into account values that are in single or double quotes. Used to parse attributes from html tag, or name/value pairs from CSS style

Parameters:

text -

delimChar - ex: '=', or ':'

bIncludeDelim - if true then the delim will be included in the tokens

begChar - ex: '<'

endChar - ex: '>'

eovChar - end of value, ex: ';'

Returns:

getHTMLAttributeMap

public static Map<String,String> getHTMLAttributeMap(String htmlTag)

getCSSMap

public static Map<String,String> getCSSMap(String style)

parseInt

public static int parseInt(String val)

toString
```
public static String toString(String str)
```
Convert to a string, if null then it returns ""

toNonNull

public static String toNonNull(String str)

getNonNull

public static String getNonNull(String str)

convertToNonNull

public static String convertToNonNull(String str)

toString

public static String toString(String str,
                              String strIfNull)

Convert to a string, if null then it returns ""

defaultString
```
public static String defaultString(String str)
```
Convert to a string, if null then it returns ""

defaultString

public static String defaultString(String str,
                                   String strIfNull)

Convert to a string, if null then return strIfNull

notNull
```
public static String notNull(String s)
```
Convert to a string, if null then it returns ""

substring

public static String substring(String s,
                               int pos1,
                               int pos2)

main99

public static void main99(String[] args)

mainB

public static void mainB(String[] args)

makeJavaIndentifier
```
public static String makeJavaIndentifier(String txt)
```
Converts any non-Java indentifier characters to a '_'

convertToJavaIndentifier

public static String convertToJavaIndentifier(String txt)

getJavaIndentifier

public static String getJavaIndentifier(String txt)

removeEndingChars

public static String removeEndingChars(String s,
                                       int amt)

append

public static String append(String orig,
                            String append)

append

public static String append(String orig,
                            String append,
                            String sep)

csv

public static String csv(String toText,
                         Object value)

concat

public static String concat(String toText,
                            String value)

concat

public static String concat(String toText,
                            String value,
                            String sepChar)

concat

public static String concat(String toText,
                            String value,
                            String sepChar,
                            boolean bForce)

hilite

public static String hilite(String line,
                            String search)

hiliteIgnoreCase

public static String hiliteIgnoreCase(String line,
                                      String search,
                                      String beginTag,
                                      String endTag)

hilite

public static String hilite(String line,
                            String search,
                            String beginTag,
                            String endTag)

hilite

public static String hilite(String line,
                            String search,
                            String beginTag,
                            String endTag,
                            boolean bIgnoreCase)

main2

public static void main2(String[] args)

main

public static void main(String[] args)

Class OAString

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NL

FS

OtherFileNameChars

LoremLipsum

Constructor Detail

OAString

Method Detail

trim

getEnd

getLast

getBegin

getFirst

convertToXml

convertToHtml

convertTextToHTML

convertToXML

encodeIllegalXML

encodeIllegalXML

convertToXML

convertToXML

convertToXML

isLegalXML

decodeIllegalXML

convert

convertIgnoreCase

convert

removeCharacters

removeOtherCharacters

removeNonDigits

removeNonDigits

removeNonFileNameChars

convert

convert

getClassName

getPackageName

convertHungarian

convertToHungarian

convertToHungarian

getDisplayName

createDisplayName

convertToDisplayName

makeSingular

getPlural

getAorAn

makePlural

makePossessive

getPossessive

getTitleCase

toTitleCase

titleCase

mfcl

makeFirstCharLower

mfucl

makeFirstUpperCharsLower

mfcu

makeFirstCharUpper

getTitle

mfcu

getTitle

field

field

field

field

dcount

dcount

count

pad

align

format

format

format

format

format

format