Str (boon 0.26 API)

java.lang.Object
- org.boon.Str

```
public class Str
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static String EMPTY_STRING
Empty string

Fields
Modifier and Type	Field and Description
`static String`	`EMPTY_STRING` Empty string

Constructor Summary

Constructors
Constructor and Description

Str()

Constructors
Constructor and Description
`Str()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`add(String... strings)` Add many strings together to another
`static String`	`add(String str, char c)` Add a char to a string
`static String`	`add(String str, String str2)` Add one string to another
`static String`	`addObjects(Object... objects)` Add many objects converted to strings together.
`static char`	`atIndex(String str, int index)` Gets character at index
`static String`	`atIndex(String str, int index, char c)` Puts character at index
`static String`	`camelCase(String in)` Convert to camel case
`static String`	`camelCase(String inStr, boolean upper)` Convert to camel case and pass upper or lower
`static String`	`camelCaseLower(String in)` Convert to camel case lower (starts with lower case)
`static String`	`camelCaseUpper(String in)` Convert to camel case upper (starts with upper case)
`static String`	`compact(String str)` Gets rid of null characters lurking in the string
`static String`	`doubleQuote(String s)` double Quote a string
`static String`	`endSliceOf(String str, int end)` Gets end slice of a string.
`static void`	`equalsOrDie(CharSequence a, CharSequence b)` See if they are equal or die
`static void`	`equalsOrDie(String a, String b)` See if they are equal or die
`static String[]`	`fromCharArrayOfArrayToStringArray(char[][] split)` Convert arrays of chars to arrays of strings
`static char`	`idx(String str, int index)` Gets character at index
`static String`	`idx(String str, int index, char c)` Puts character at index
`static boolean`	`in(char[] chars, String str)` See if chars is in another string
`static boolean`	`in(char c, int offset, int end, String str)` See if a char is in a string but in a certain bounds of string
`static boolean`	`in(char c, int offset, String str)` See if a char is in a string
`static boolean`	`in(char c, String str)` See if a char is in another string
`static boolean`	`in(String value, String str)`
`static boolean`	`insideOf(String start, String inStr, String end)` Checks to see if a string is inside of another
`static boolean`	`isEmpty(String str)`
`static String`	`join(char delim, String... args)`
`static String`	`join(String... args)`
`static String`	`joinCollection(char delim, List<?> args)`
`static String`	`joinObjects(char delim, Object... args)`
`static int`	`len(String str)` gets length
`static int`	`lengthOf(String str)` gets length
`static String`	`lines(String... lines)`
`static String`	`linesConvertQuotes(String... lines)`
`static String`	`lower(String str)` Convert to lower case
`static String`	`lpad(Object inStr)`
`static String`	`lpad(Object inStr, int size)`
`static String`	`lpad(String inStr, int size)`
`static String`	`lpad(String inStr, int size, char fill)`
`static String`	`num(Number count)` Do a nice pretty print of a number.
`static String`	`quote(String s)` Quote a string
`static String`	`readable(String s)`
`static String`	`rpad(Object obj)`
`static String`	`rpad(Object obj, int size)`
`static String`	`rpad(Object obj, int size, char fill)`
`static String`	`rpad(String inStr, int size)`
`static String`	`rpad(String inStr, int size, char fill)`
`static String`	`singleQuote(String s)` single Quote a string
`static String`	`slc(String str, int start)` Gets slice of a string.
`static String`	`slc(String str, int start, int end)` Get slice of string
`static String`	`slcEnd(String str, int end)` Gets end slice of a string.
`static String`	`sliceOf(String str, int start)` Gets slice of a string.
`static String`	`sliceOf(String str, int start, int end)` Get slice of string
`static String[]`	`split(String str)` Split a string
`static String[]`	`split(String input, char split)`
`static String[]`	`splitByPipe(String str)` Split a string by pipe
`static String[]`	`splitBySpace(String str)` Split a string by space
`static String[]`	`splitComma(String str)` Split a string by commas
`static String[]`	`splitLines(String str)` Split a string by lines
`static boolean`	`startsWithItemInCollection(String name, Collection<String> startsWithList)`
`static String`	`str(byte[] bytes)` Create a string from bytes.
`static String`	`str(Object str)`
`static String`	`toString(Object object)`
`static String`	`toString(Object object, String defaultString)`
`static String`	`uncapitalize(String string)`
`static String`	`underBarCase(String inStr)` Convert to under bar case
`static String`	`upper(String str)` Convert to upper case
`static String`	`zfill(int num, int size)`

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

- Field Detail
  - EMPTY_STRING
```
public static final String EMPTY_STRING
```
    Empty string
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Str
```
public Str()
```
- Method Detail
  - lengthOf
```
public static int lengthOf(String str)
```
    gets length
    
    Parameters:
    str - string
    
    Returns:
    length
  - sliceOf
```
public static String sliceOf(String str,
             int start)
```
    Gets slice of a string.
    
    Parameters:
    str - string
    start - start index of slice
    
    Returns:
    new string
  - sliceOf
```
public static String sliceOf(String str,
             int start,
             int end)
```
    Get slice of string
    
    Parameters:
    str - string
    start - start index
    end - end index
    
    Returns:
    new string
  - endSliceOf
```
public static String endSliceOf(String str,
                int end)
```
    Gets end slice of a string.
    
    Parameters:
    str - string
    end - end index of slice
    
    Returns:
    new string
  - atIndex
```
public static char atIndex(String str,
           int index)
```
    Gets character at index
    
    Parameters:
    str - string
    index - index
    
    Returns:
    char at
  - atIndex
```
public static String atIndex(String str,
             int index,
             char c)
```
    Puts character at index
    
    Parameters:
    str - string
    index - index
    c - char to put in
    
    Returns:
    new string
  - len
```
public static int len(String str)
```
    gets length
    
    Parameters:
    str - string
    
    Returns:
    length
  - slc
```
public static String slc(String str,
         int start)
```
    Gets slice of a string.
    
    Parameters:
    str - string
    start - start index of slice
    
    Returns:
    new string
  - slc
```
public static String slc(String str,
         int start,
         int end)
```
    Get slice of string
    
    Parameters:
    str - string
    start - start index
    end - end index
    
    Returns:
    new string
  - slcEnd
```
public static String slcEnd(String str,
            int end)
```
    Gets end slice of a string.
    
    Parameters:
    str - string
    end - end index of slice
    
    Returns:
    new string
  - idx
```
public static char idx(String str,
       int index)
```
    Gets character at index
    
    Parameters:
    str - string
    index - index
    
    Returns:
    char at
  - idx
```
public static String idx(String str,
         int index,
         char c)
```
    Puts character at index
    
    Parameters:
    str - string
    index - index
    c - char to put in
    
    Returns:
    new string
  - in
```
public static boolean in(char[] chars,
         String str)
```
    See if chars is in another string
    
    Parameters:
    chars - chars
    str - string
    
    Returns:
    true or false
  - in
```
public static boolean in(char c,
         String str)
```
    See if a char is in another string
    
    Parameters:
    c - char
    str - string
    
    Returns:
    true or false
  - in
```
public static boolean in(char c,
         int offset,
         String str)
```
    See if a char is in a string
    
    Parameters:
    c - char
    offset - offset
    str - string
    
    Returns:
    true or false
  - in
```
public static boolean in(char c,
         int offset,
         int end,
         String str)
```
    See if a char is in a string but in a certain bounds of string
    
    Parameters:
    c - char
    offset - offset
    end - end of span to search
    str - string
    
    Returns:
    true or false
  - add
```
public static String add(String str,
         char c)
```
    Add a char to a string
    
    Parameters:
    str - string
    c - char
    
    Returns:
    new string
  - add
```
public static String add(String str,
         String str2)
```
    Add one string to another
    
    Parameters:
    str - string 1
    str2 - string 2
    
    Returns:
    new string
  - add
```
public static String add(String... strings)
```
    Add many strings together to another
    
    Parameters:
    strings - strings
    
    Returns:
    new string
  - addObjects
```
public static String addObjects(Object... objects)
```
    Add many objects converted to strings together. Null are ignored so be careful.
    
    Parameters:
    objects - objects to convert to strings
    
    Returns:
    new string
  - compact
```
public static String compact(String str)
```
    Gets rid of null characters lurking in the string
    
    Parameters:
    str - string
    
    Returns:
    new string
  - split
```
public static String[] split(String str)
```
    Split a string
    
    Parameters:
    str - string to split
    
    Returns:
    string array
  - splitLines
```
public static String[] splitLines(String str)
```
    Split a string by lines
    
    Parameters:
    str - string to split
    
    Returns:
    string array
  - splitComma
```
public static String[] splitComma(String str)
```
    Split a string by commas
    
    Parameters:
    str - string to split
    
    Returns:
    string array
  - splitBySpace
```
public static String[] splitBySpace(String str)
```
    Split a string by space
    
    Parameters:
    str - string to split
    
    Returns:
    string array
  - splitByPipe
```
public static String[] splitByPipe(String str)
```
    Split a string by pipe
    
    Parameters:
    str - string to split
    
    Returns:
    string array
  - fromCharArrayOfArrayToStringArray
```
public static String[] fromCharArrayOfArrayToStringArray(char[][] split)
```
    Convert arrays of chars to arrays of strings
    
    Parameters:
    split - array of chars
    
    Returns:
    string array
  - upper
```
public static String upper(String str)
```
    Convert to upper case
    
    Parameters:
    str - string to convert
    
    Returns:
    new string
  - lower
```
public static String lower(String str)
```
    Convert to lower case
    
    Parameters:
    str - string to convert
    
    Returns:
    new string
  - camelCaseUpper
```
public static String camelCaseUpper(String in)
```
    Convert to camel case upper (starts with upper case)
    
    Parameters:
    in - string to convert
    
    Returns:
    new string
  - camelCaseLower
```
public static String camelCaseLower(String in)
```
    Convert to camel case lower (starts with lower case)
    
    Parameters:
    in - string to convert
    
    Returns:
    new string
  - camelCase
```
public static String camelCase(String in)
```
    Convert to camel case
    
    Parameters:
    in - string to convert
    
    Returns:
    new string
  - camelCase
```
public static String camelCase(String inStr,
               boolean upper)
```
    Convert to camel case and pass upper or lower
    
    Parameters:
    inStr - string to convert
    upper - upper flag
    
    Returns:
    new string
  - insideOf
```
public static boolean insideOf(String start,
               String inStr,
               String end)
```
    Checks to see if a string is inside of another
    
    Parameters:
    start - start
    inStr - input string
    end - index at end
    
    Returns:
  - underBarCase
```
public static String underBarCase(String inStr)
```
    Convert to under bar case
    
    Parameters:
    inStr - input string
    
    Returns:
    new string
  - equalsOrDie
```
public static void equalsOrDie(CharSequence a,
               CharSequence b)
```
    See if they are equal or die
    
    Parameters:
    a - a
    b - b
  - equalsOrDie
```
public static void equalsOrDie(String a,
               String b)
```
    See if they are equal or die
    
    Parameters:
    a - a
    b - b
  - lpad
```
public static String lpad(String inStr,
          int size,
          char fill)
```
    Parameters:
    inStr -
    size -
    fill -
    
    Returns:
  - lpad
```
public static String lpad(String inStr,
          int size)
```
    Parameters:
    inStr -
    size -
    
    Returns:
  - lpad
```
public static String lpad(Object inStr,
          int size)
```
    Parameters:
    inStr -
    size -
    
    Returns:
  - lpad
```
public static String lpad(Object inStr)
```
    Parameters:
    inStr -
    
    Returns:
  - zfill
```
public static String zfill(int num,
           int size)
```
    Parameters:
    num -
    size -
    
    Returns:
  - rpad
```
public static String rpad(String inStr,
          int size,
          char fill)
```
    Parameters:
    inStr -
    size -
    fill -
    
    Returns:
  - rpad
```
public static String rpad(String inStr,
          int size)
```
    Parameters:
    inStr -
    size -
    
    Returns:
  - rpad
```
public static String rpad(Object obj,
          int size)
```
    Parameters:
    obj -
    size -
    
    Returns:
  - rpad
```
public static String rpad(Object obj)
```
    Parameters:
    obj -
    
    Returns:
  - rpad
```
public static String rpad(Object obj,
          int size,
          char fill)
```
    Parameters:
    obj -
    size -
    fill -
    
    Returns:
  - split
```
public static String[] split(String input,
             char split)
```
    Parameters:
    input -
    split -
    
    Returns:
  - in
```
public static boolean in(String value,
         String str)
```
    Parameters:
    value -
    str -
    
    Returns:
  - lines
```
public static String lines(String... lines)
```
    Parameters:
    lines -
    
    Returns:
  - linesConvertQuotes
```
public static String linesConvertQuotes(String... lines)
```
    Parameters:
    lines -
    
    Returns:
  - join
```
public static String join(char delim,
          String... args)
```
    Parameters:
    delim -
    args -
    
    Returns:
  - joinObjects
```
public static String joinObjects(char delim,
                 Object... args)
```
    Parameters:
    delim -
    args -
    
    Returns:
  - join
```
public static String join(String... args)
```
    Parameters:
    args -
    
    Returns:
  - joinCollection
```
public static String joinCollection(char delim,
                    List<?> args)
```
    Parameters:
    delim -
    args -
    
    Returns:
  - isEmpty
```
public static boolean isEmpty(String str)
```
    Parameters:
    str -
    
    Returns:
  - uncapitalize
```
public static String uncapitalize(String string)
```
    Parameters:
    string -
    
    Returns:
  - toString
```
public static String toString(Object object,
              String defaultString)
```
    Parameters:
    object -
    defaultString -
    
    Returns:
  - toString
```
public static String toString(Object object)
```
    Parameters:
    object -
    
    Returns:
  - str
```
public static String str(Object str)
```
    Parameters:
    str -
    
    Returns:
  - startsWithItemInCollection
```
public static boolean startsWithItemInCollection(String name,
                                 Collection<String> startsWithList)
```
    Parameters:
    name -
    startsWithList -
    
    Returns:
  - readable
```
public static String readable(String s)
```
  - quote
```
public static String quote(String s)
```
    Quote a string
    
    Parameters:
    s - input string
    
    Returns:
    new String
  - singleQuote
```
public static String singleQuote(String s)
```
    single Quote a string
    
    Parameters:
    s - input string
    
    Returns:
    new String
  - doubleQuote
```
public static String doubleQuote(String s)
```
    double Quote a string
    
    Parameters:
    s - input string
    
    Returns:
    new String
  - str
```
public static String str(byte[] bytes)
```
    Create a string from bytes.
    
    Parameters:
    bytes - bytes in
    
    Returns:
    string out
  - num
```
public static String num(Number count)
```
    Do a nice pretty print of a number. Add commas and such.
    
    Parameters:
    count - number
    
    Returns:
    string format of number

Class Str

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_STRING

Constructor Detail

Str

Method Detail

lengthOf

sliceOf

sliceOf

endSliceOf

atIndex

atIndex

len

slc

slc

slcEnd

idx

idx

in

in

in

in

add

add

add

addObjects

compact

split

splitLines

splitComma

splitBySpace

splitByPipe

fromCharArrayOfArrayToStringArray

upper

lower

camelCaseUpper

camelCaseLower

camelCase

camelCase

insideOf

underBarCase

equalsOrDie

equalsOrDie

lpad

lpad

lpad

lpad

zfill

rpad

rpad

rpad

rpad

rpad

split

in

lines

linesConvertQuotes

join

joinObjects

join

joinCollection

isEmpty

uncapitalize

toString

toString

str

startsWithItemInCollection

readable

quote

singleQuote

doubleQuote

str

num