StringGrabber (string-grabber 0.1.0 API)

java.lang.Object
- org.riversun.string_grabber.StringGrabber

```
public class StringGrabber
extends Object
```
String wrapper class easy to manipulate String
To operate followings easily
Partial cutout of string
binding
add
search
conversion
replace

Author:

Tom Misawa (riversun.org@gmail.com)

Constructor Summary

Constructors
Constructor and Description

StringGrabber()

StringGrabber(String str)

StringGrabber(StringGrabber sg)

Constructors
Constructor and Description
`StringGrabber()`
`StringGrabber(String str)`
`StringGrabber(StringGrabber sg)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringGrabber`	`append(String str)` append string
`StringGrabber`	`appendRepeat(String str, int repeatCount)` Append a string to be repeated
`StringGrabber`	`carryHead(int charCount)` To leave N character from head , cut off the rest
`StringGrabber`	`carryTail(int charCount)` To leave the tail of the N character , cut off the rest
`StringGrabber`	`copy()`
`boolean`	`equals(StringGrabber sg)` Compares this object to the specified object.
`StringGrabber`	`getLastPartsSeparatedBy(String separator)` returns the last part that was separated by the specified string
`StringGrabberList`	`getStringEnclosedIn(String startToken, String endToken)` returns all of discovery that enclosed in specific tokens found in the source string
`StringGrabber`	`getStringEnclosedInFirst(String startToken, String endToken)` returns the first one that enclosed in specific tokens found in the source string.
`StringGrabber`	`insertIntoHead(String str)` Insert string into the first
`StringGrabber`	`insertRepeat(String str, int repeatCount)` Append a string to be repeated into head
`boolean`	`isEmpty()` returns true if and only if length() is 0.
`boolean`	`isNotEmpty()` returns true if and only if length() is NOT 0.
`StringGrabber`	`left(int charCount)` returns a new string that is a substring of this string from left.
`int`	`length()`
`StringGrabber`	`newLine()` append new line to the String
`StringGrabber`	`removeHead(int cnt)` remove from first
`StringGrabber`	`removeTail()` remove last char
`StringGrabber`	`removeTail(int cnt)` remove from tail
`StringGrabber`	`replace(String target, String replacement)` replace specified string
`StringGrabber`	`replaceEnclosedIn(String startToken, String endToken, String replacement)` replace specified string enclosed in speficied token
`StringGrabber`	`replaceFirstToLowerCase()` convert first char to lower case
`StringGrabber`	`replaceFirstToUpperCase()` convert first char to upper case
`StringGrabber`	`replaceToLowerCase(int pos)` convert string in the specified position to lower case
`StringGrabber`	`replaceToLowerCase(int startPos, int endPos)` convert string in the specified position(range) to lower case
`StringGrabber`	`replaceToUpperCase(int pos)` convert string in the specified position to upper case
`StringGrabber`	`replaceToUpperCase(int startPos, int endPos)` convert string in the specified position(range) to upper case
`StringGrabber`	`right(int charCount)` returns a new string that is a substring of this string from right.
`StringGrabber`	`set(String str)` set new source of string to this class
`StringGrabber`	`set(StringBuilder stringBuilder)` set new source of stringbuilder to this class
`static void`	`setNewLine(String newLine)` set new line char(s) for StringGrabber
`StringGrabberList`	`split(String regexp)` Splits this string around matches of the given regular expression.
`StringGrabber`	`substring(int startIdx, int endIndex)` returns substring specified with start index and endIndex
`boolean`	`toBoolean(boolean defaultValue)` returns boolean value ,when format error occurred ,returns default value
`double`	`toDouble(double defaultValue)` returns double value ,when format error occurred ,returns default value
`float`	`toFloat(float defaultValue)` returns float value ,when format error occurred ,returns default value
`int`	`toInt(int defaultValue)` returns int value ,when format error occurred ,returns default value
`StringGrabber`	`toLowerCase()` conver all chars to lower case
`StringGrabberList`	`toSgList()` return what was split by a newline code
`String`	`toString()`
`StringGrabber`	`toUpperCase()` conver all chars to upper case

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

- Constructor Detail
  - StringGrabber
```
public StringGrabber()
```
  - StringGrabber
```
public StringGrabber(String str)
```
  - StringGrabber
```
public StringGrabber(StringGrabber sg)
```
- Method Detail
  - setNewLine
```
public static void setNewLine(String newLine)
```
    set new line char(s) for StringGrabber
    
    Parameters:
    
    newLine -
  - copy
```
public StringGrabber copy()
```
  - append
```
public StringGrabber append(String str)
```
    append string
    
    Parameters:
    
    str -
    
    Returns:
  - set
```
public StringGrabber set(String str)
```
    set new source of string to this class
    
    Parameters:
    
    str -
    
    Returns:
  - set
```
public StringGrabber set(StringBuilder stringBuilder)
```
    set new source of stringbuilder to this class
    
    Parameters:
    
    stringBuilder -
    
    Returns:
  - removeTail
```
public StringGrabber removeTail()
```
    remove last char
    
    Returns:
    
    See Also:
    
    StringGrabber#carryTail()
  - removeHead
```
public StringGrabber removeHead(int cnt)
```
    remove from first
    
    Parameters:
    
    cnt - count of chars
    
    Returns:
    
    See Also:
    
    StringGrabber#carryHead()
  - removeTail
```
public StringGrabber removeTail(int cnt)
```
    remove from tail
    
    Parameters:
    
    cnt - count of chars
    
    Returns:
    
    See Also:
    
    StringGrabber#carryTail()
  - toLowerCase
```
public StringGrabber toLowerCase()
```
    conver all chars to lower case
    
    Returns:
    
    See Also:
    
    toUpperCase()
  - toUpperCase
```
public StringGrabber toUpperCase()
```
    conver all chars to upper case
    
    Returns:
    
    See Also:
    
    toUpperCase()
  - replaceFirstToLowerCase
```
public StringGrabber replaceFirstToLowerCase()
```
    convert first char to lower case
    
    Returns:
  - replaceToLowerCase
```
public StringGrabber replaceToLowerCase(int pos)
```
    convert string in the specified position to lower case
    
    Parameters:
    
    pos -
    
    Returns:
  - replaceToLowerCase
```
public StringGrabber replaceToLowerCase(int startPos,
                                        int endPos)
```
    convert string in the specified position(range) to lower case
    
    Parameters:
    
    startPos -
    
    endPos -
    
    Returns:
  - replaceFirstToUpperCase
```
public StringGrabber replaceFirstToUpperCase()
```
    convert first char to upper case
    
    Returns:
  - replaceToUpperCase
```
public StringGrabber replaceToUpperCase(int pos)
```
    convert string in the specified position to upper case
    
    Parameters:
    
    pos -
    
    Returns:
  - replaceToUpperCase
```
public StringGrabber replaceToUpperCase(int startPos,
                                        int endPos)
```
    convert string in the specified position(range) to upper case
    
    Parameters:
    
    startPos -
    
    endPos -
    
    Returns:
  - insertIntoHead
```
public StringGrabber insertIntoHead(String str)
```
    Insert string into the first
    
    Parameters:
    
    str -
    
    Returns:
  - left
```
public StringGrabber left(int charCount)
```
    returns a new string that is a substring of this string from left.
    
    Parameters:
    
    cnt -
    
    Returns:
  - right
```
public StringGrabber right(int charCount)
```
    returns a new string that is a substring of this string from right.
    
    Parameters:
    
    charCount -
    
    Returns:
  - replace
```
public StringGrabber replace(String target,
                             String replacement)
```
    replace specified string
    
    Parameters:
    
    target -
    
    replacement -
    
    Returns:
  - replaceEnclosedIn
```
public StringGrabber replaceEnclosedIn(String startToken,
                                       String endToken,
                                       String replacement)
```
    replace specified string enclosed in speficied token
    
    Parameters:
    
    startToken -
    
    endToken -
    
    replacement -
    
    Returns:
  - substring
```
public StringGrabber substring(int startIdx,
                               int endIndex)
```
    returns substring specified with start index and endIndex
    
    Parameters:
    
    startIdx -
    
    endIndex -
    
    Returns:
  - length
```
public int length()
```
  - getLastPartsSeparatedBy
```
public StringGrabber getLastPartsSeparatedBy(String separator)
```
    returns the last part that was separated by the specified string
    
    Parameters:
    
    separator -
    
    Returns:
  - toInt
```
public int toInt(int defaultValue)
```
    returns int value ,when format error occurred ,returns default value
    
    Parameters:
    
    defaultValue -
    
    Returns:
  - toDouble
```
public double toDouble(double defaultValue)
```
    returns double value ,when format error occurred ,returns default value
    
    Parameters:
    
    defaultValue -
    
    Returns:
  - toFloat
```
public float toFloat(float defaultValue)
```
    returns float value ,when format error occurred ,returns default value
    
    Parameters:
    
    defaultValue -
    
    Returns:
  - toBoolean
```
public boolean toBoolean(boolean defaultValue)
```
    returns boolean value ,when format error occurred ,returns default value
    
    Parameters:
    
    defaultValue -
    
    Returns:
  - appendRepeat
```
public StringGrabber appendRepeat(String str,
                                  int repeatCount)
```
    Append a string to be repeated
    
    Parameters:
    
    str -
    
    repeatCount -
    
    Returns:
    
    See Also:
    
    StringGrabber#insertRepeat(String);
  - insertRepeat
```
public StringGrabber insertRepeat(String str,
                                  int repeatCount)
```
    Append a string to be repeated into head
    
    Parameters:
    
    str -
    
    repeatCount -
    
    Returns:
    
    See Also:
    
    StringGrabber#insertRepeat(String);
  - carryHead
```
public StringGrabber carryHead(int charCount)
```
    To leave N character from head , cut off the rest
    
    Parameters:
    
    charCount -
    
    Returns:
    
    See Also:
    
    StringGrabber#removeHead()
  - carryTail
```
public StringGrabber carryTail(int charCount)
```
    To leave the tail of the N character , cut off the rest
    
    Parameters:
    
    charCount -
    
    Returns:
    
    See Also:
    
    removeTail()
  - isEmpty
```
public boolean isEmpty()
```
    returns true if and only if length() is 0.
    
    Returns:
    
    See Also:
    
    isNotEmpty()
  - isNotEmpty
```
public boolean isNotEmpty()
```
    returns true if and only if length() is NOT 0.
    
    Returns:
    
    See Also:
    
    isEmpty()
  - getStringEnclosedInFirst
```
public StringGrabber getStringEnclosedInFirst(String startToken,
                                              String endToken)
```
    returns the first one that enclosed in specific tokens found in the source string.
    
    Parameters:
    
    startToken -
    
    endToken -
    
    Returns:
  - getStringEnclosedIn
```
public StringGrabberList getStringEnclosedIn(String startToken,
                                             String endToken)
```
    returns all of discovery that enclosed in specific tokens found in the source string
    
    Parameters:
    
    startToken -
    
    endToken -
    
    Returns:
  - split
```
public StringGrabberList split(String regexp)
```
    Splits this string around matches of the given regular expression.
    
    Parameters:
    
    regexp -
    
    Returns:
  - toSgList
```
public StringGrabberList toSgList()
```
    return what was split by a newline code
    
    Returns:
  - newLine
```
public StringGrabber newLine()
```
    append new line to the String
    
    Returns:
  - equals
```
public boolean equals(StringGrabber sg)
```
    Compares this object to the specified object.
    
    Parameters:
    
    sg -
    
    Returns:
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class StringGrabber

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringGrabber

StringGrabber

StringGrabber

Method Detail

setNewLine

copy

append

set

set

removeTail

removeHead

removeTail

toLowerCase

toUpperCase

replaceFirstToLowerCase

replaceToLowerCase

replaceToLowerCase

replaceFirstToUpperCase

replaceToUpperCase

replaceToUpperCase

insertIntoHead

left

right

replace

replaceEnclosedIn

substring

length

getLastPartsSeparatedBy

toInt

toDouble

toFloat

toBoolean

appendRepeat

insertRepeat

carryHead

carryTail

isEmpty

isNotEmpty

getStringEnclosedInFirst

getStringEnclosedIn

split

toSgList

newLine

equals

toString