StringHelper (TwelBox 1.05)

java.lang.Object
- org.brains2b.util.StringHelper

```
public final class StringHelper
extends java.lang.Object
```
Some static functions that help with Stringmanipulation.

Version:

0.21.2 [30-06-2007]

Author:

dennis@brains2b.nl

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.String`	`baseOnly(java.lang.String str)` Returns only the base capitilazid characters [A-Z][0-9] All other characters are removed from the String
`static java.lang.String`	`breakLine(java.lang.String str, int maxLen)` Breaks a String after a maximun number of characters on the first space or punctuation before that maximum.
`static int`	`count(java.lang.String s, char c)` Count the number of characters c in String s
`static int`	`getNonBaseCharacter(java.lang.String value)` get the first non-base character (not A-Z,a-z,0-9) from the start of the String
`static int`	`getNonBaseCharacter(java.lang.String value, int start)` get the first non-base character (not A-Z,a-z,0-9) from start
`static int`	`indexOfWord(java.lang.String source, java.lang.String word, int begin)` get the index of the start of word within the String
`static java.lang.String`	`initCaps(java.lang.String str, char c)` Capitalize the first Letter in a String and all letters following the char.
`static boolean`	`isEmpty(java.lang.String s)` check if a String is empty, meaning a String of length zero or null
`static boolean`	`isNumber(java.lang.String s)` check if the given String is a number.
`static boolean`	`isQuoteCharacter(char a)` check is a character is a quote: " or &
`static java.lang.String`	`join(java.lang.String seperator, java.util.Collection s)` Deprecated. From Java 1.8 use String#join
`static java.lang.String`	`leftPad(java.lang.String str, java.lang.String filler, int len)` Pads a String to the left with th filler String until len is reached If the String is longer then the length the string will be truncated on the left to not return more then lenght characters
`static java.lang.String`	`leftTrim(java.lang.String s)` Trim spaces to the left
`static int`	`matchBracket(char left, java.lang.String line)` Finds the matching bracket for the first character given by left in String line.
`static int`	`matchBracket(int pos, java.lang.String line)` Finds the matching bracket for the bracket character at pos in line.
`static java.lang.String`	`rightPad(java.lang.String str, java.lang.String filler, int len)` Pads a String to the right with the filler String until len is reached If the String is longer then the length the string will be truncated on the right to not return more then lenght characters
`static java.lang.String`	`rightTrim(java.lang.String s)` Trim spaces to the right
`static java.lang.String`	`rightTrim(java.lang.String s, char c)` Trim off all chars c from the right
`static java.lang.String`	`stripper(java.lang.String str, char c)` Strips a character from a String.

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

- Method Detail
  - initCaps
```
public static java.lang.String initCaps(java.lang.String str,
                                        char c)
```
    Capitalize the first Letter in a String and all letters following the char.
    
    Parameters:
    
    str - String, the String that needs to be InitCapped.
    
    c - char, The character after which letters should be capitalized
    
    Returns:
    
    String, the InitCapped String, returns null if str is null
  - stripper
```
public static java.lang.String stripper(java.lang.String str,
                                        char c)
```
    Strips a character from a String. The String will become shortend for every occurance of the char.
    
    Parameters:
    
    str - String, from which the character should be removed
    
    c - char, the Character that needs to be removd
    
    Returns:
    
    String, the String minus the characters that where removed, returns null when str is null
  - getNonBaseCharacter
```
public static int getNonBaseCharacter(java.lang.String value)
```
    get the first non-base character (not A-Z,a-z,0-9) from the start of the String
    
    Parameters:
    
    value - String
    
    Returns:
    
    int index of first non-base character in value, -1 if not found
  - getNonBaseCharacter
```
public static int getNonBaseCharacter(java.lang.String value,
                                      int start)
```
    get the first non-base character (not A-Z,a-z,0-9) from start
    
    Parameters:
    
    value - String
    
    start - int
    
    Returns:
    
    int index of first non-base character in value, -1 if not found
  - baseOnly
```
public static java.lang.String baseOnly(java.lang.String str)
```
    Returns only the base capitilazid characters [A-Z][0-9] All other characters are removed from the String
    
    Parameters:
    
    str - String, the value to be 'based'
    
    Returns:
    
    String, the 'based' value
  - breakLine
```
public static final java.lang.String breakLine(java.lang.String str,
                                               int maxLen)
```
    Breaks a String after a maximun number of characters on the first space or punctuation before that maximum. Uses the default lineseparator from the running System
    
    Returns:
    
    String, the String including linebreaks, returns null when str is null
  - leftPad
```
public static java.lang.String leftPad(java.lang.String str,
                                       java.lang.String filler,
                                       int len)
```
    Pads a String to the left with th filler String until len is reached If the String is longer then the length the string will be truncated on the left to not return more then lenght characters
    
    Parameters:
    
    str - String, if str is null, it will be threated as a zero length string
    
    filler - String, the String that fills the original String on the left until length.
    
    len - int, the length of the output string
    
    Returns:
    
    String the leftpadded String
    
    Throws:
    
    java.lang.NullPointerException - thrown if filler is null
  - rightPad
```
public static java.lang.String rightPad(java.lang.String str,
                                        java.lang.String filler,
                                        int len)
```
    Pads a String to the right with the filler String until len is reached If the String is longer then the length the string will be truncated on the right to not return more then lenght characters
    
    Parameters:
    
    str - String, if str is null, it will be threated as a zero length string
    
    filler - String, the String that fills the original String on the left until length
    
    len - int, the length of the output string
    
    Returns:
    
    String the leftpadded String
    
    Throws:
    
    java.lang.NullPointerException - thrown if filler is null
  - leftTrim
```
public static java.lang.String leftTrim(java.lang.String s)
```
    Trim spaces to the left
    
    Parameters:
    
    s - String, input
    
    Returns:
    
    String the trimmed String
  - rightTrim
```
public static java.lang.String rightTrim(java.lang.String s)
```
    Trim spaces to the right
    
    Parameters:
    
    s - String, input
    
    Returns:
    
    String the trimmed String
  - rightTrim
```
public static java.lang.String rightTrim(java.lang.String s,
                                         char c)
```
    Trim off all chars c from the right
    
    Parameters:
    
    s - String, input
    
    c - char to trim off
    
    Returns:
    
    String the trimmed String
  - matchBracket
```
public static int matchBracket(char left,
                               java.lang.String line)
```
    Finds the matching bracket for the first character given by left in String line.
    
    Parameters:
    
    left - char, the bracket character ",',{,[,( one is looking for
    
    line - String, the line to find the matching bracket in
    
    Returns:
    
    int, the position where the bracket ends in line x, returns -1 if no at pos no bracket could be found or if the matching bracket could not be found
    
    See Also:
    
    matchBracket(int, String)
  - matchBracket
```
public static int matchBracket(int pos,
                               java.lang.String line)
```
    Finds the matching bracket for the bracket character at pos in line.
    
    Parameters:
    
    pos - int, The position of the matching bracket, valid brackets are ",',{,[,(
    
    line - String, the line to find the matching bracket in
    
    Returns:
    
    int, the position where the bracket ends in line x, returns -1 if no at pos no bracket could be found or if the matching bracket could not be found
  - isQuoteCharacter
```
public static boolean isQuoteCharacter(char a)
```
    check is a character is a quote: " or &
    
    Parameters:
    
    a - char, the char to test
    
    Returns:
    
    boolean true if quote, false otherwise
  - isEmpty
```
public static boolean isEmpty(java.lang.String s)
```
    check if a String is empty, meaning a String of length zero or null
    
    Parameters:
    
    s - String, to test for empty
    
    Returns:
    
    true if String is empty, false otherwise
  - isNumber
```
public static final boolean isNumber(java.lang.String s)
```
    check if the given String is a number. The String can contain minus,thousand and decimal separator
    
    Parameters:
    
    s - String
    
    Returns:
    
    true if String is a number, false otherwise
  - count
```
public static final int count(java.lang.String s,
                              char c)
```
    Count the number of characters c in String s
    
    Parameters:
    
    s - String
    
    c - char
    
    Returns:
    
    the number of characters is String s, returns 0 if String is null or empty
  - join
```
@Deprecated
public static final java.lang.String join(java.lang.String seperator,
                                                      java.util.Collection s)
```
    Deprecated. From Java 1.8 use String#join
    
    join a Collection as a concatenation of Strings with the chosen separator
    
    Parameters:
    
    seperator - the chosen separator
    
    s - Collection of Strings to concat
    
    Returns:
    
    concatenation of Strings separated by the separator
  - indexOfWord
```
public static final int indexOfWord(java.lang.String source,
                                    java.lang.String word,
                                    int begin)
```
    get the index of the start of word within the String
    
    Parameters:
    
    source - String
    
    word - String the word to find checking for whitespace around it
    
    begin - int start index
    
    Returns:
    
    int index of word

Class StringHelper

Method Summary

Methods inherited from class java.lang.Object

Method Detail

initCaps

stripper

getNonBaseCharacter

getNonBaseCharacter

baseOnly

breakLine

leftPad

rightPad

leftTrim

rightTrim

rightTrim

matchBracket

matchBracket

isQuoteCharacter

isEmpty

isNumber

count

join

indexOfWord