ToStringBuilder (Avail 1.5.0 API)

java.lang.Object
- com.frostphyr.avail.ToStringBuilder

```
public class ToStringBuilder
extends Object
```
A utility builder class to simplify the creation of a String for Object.toString().
The builder uses a class name and any number of name-value pairs. The format of the output is:
ClassName[name=value,arrayName=[value,value],mapName=[key>value]

Since:

1.0

Constructor Summary

Constructors
Modifier Constructor and Description

protected ToStringBuilder()
Empty constructor; use one of the static methods for creation.

Constructors
Modifier	Constructor and Description
`protected`	`ToStringBuilder()` Empty constructor; use one of the static methods for creation.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ToStringBuilder`	`append(String name, boolean value)` Appends the `name`-`value` pair.
`ToStringBuilder`	`append(String name, boolean[] values)` Appends the `name`-`values` pair.
`ToStringBuilder`	`append(String name, byte[] values)` Appends the `name`-`values` pair.
`ToStringBuilder`	`append(String name, char value)` Appends the `name`-`value` pair.
`ToStringBuilder`	`append(String name, char[] values)` Appends the `name`-`values` pair.
`ToStringBuilder`	`append(String name, double value)` Appends the `name`-`value` pair.
`ToStringBuilder`	`append(String name, double[] values)` Appends the `name`-`values` pair.
`ToStringBuilder`	`append(String name, float value)` Appends the `name`-`value` pair.
`ToStringBuilder`	`append(String name, float[] values)` Appends the `name`-`values` pair.
`ToStringBuilder`	`append(String name, int value)` Appends the `name`-`value` pair.
`ToStringBuilder`	`append(String name, int[] values)` Appends the `name`-`values` pair.
`ToStringBuilder`	`append(String name, Iterable<?> iterable)` Appends the `name`-`iterable` pair.
`ToStringBuilder`	`append(String name, long value)` Appends the `name`-`value` pair.
`ToStringBuilder`	`append(String name, long[] values)` Appends the `name`-`values` pair.
`<K,V> ToStringBuilder`	`append(String name, Map<K,V> map)` Appends the `name`-`map` pair.
`ToStringBuilder`	`append(String name, Object value)` Appends the `name`-`value` pair.
`ToStringBuilder`	`append(String name, Object[] values)` Appends the `name`-`values` pair.
`ToStringBuilder`	`append(String name, short[] values)` Appends the `name`-`values` pair.
`static ToStringBuilder`	`forClass(Class<?> clazz)` Creates a new `ToStringBuilder` for `clazz`.
`static ToStringBuilder`	`forClassName(String className)` Creates a new `ToStringBuilder` for `className`.
`static ToStringBuilder`	`forObject(Object object)` Creates a new `ToStringBuilder` for `object`.
`String`	`toString()`

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

- Constructor Detail
  - ToStringBuilder
```
protected ToStringBuilder()
```
    Empty constructor; use one of the static methods for creation.
    
    Since:
    
    1.5
- Method Detail
  - forClassName
```
public static ToStringBuilder forClassName(String className)
```
    Creates a new ToStringBuilder for className.
    
    Parameters:
    
    className - the name of the Class whose string is being built
    
    Returns:
    
    the created builder
    
    Throws:
    
    IllegalArgumentException - if className is null
  - forClass
```
public static ToStringBuilder forClass(Class<?> clazz)
```
    Creates a new ToStringBuilder for clazz. This is equivalent to calling forClassName(String) with Class.getSimpleName().
    
    Parameters:
    
    clazz - the Class whose string is being built
    
    Returns:
    
    the created builder
    
    Throws:
    
    IllegalArgumentException - if clazz is null
  - forObject
```
public static ToStringBuilder forObject(Object object)
```
    Creates a new ToStringBuilder for object. This is equivalent to calling forClass(Class) with Object.getClass().
    
    Parameters:
    
    object - the Object whose string is being built
    
    Returns:
    
    the created builder
    
    Throws:
    
    IllegalArgumentException - if object is null
    
    Since:
    
    1.5
  - append
```
public ToStringBuilder append(String name,
                              Object value)
```
    Appends the name-value pair. This will use the format name=value. The value will use its respective Object.toString(), or "null" will be used if it is null.
    
    Parameters:
    
    name - the name of value
    
    value - the value to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              int value)
```
    Appends the name-value pair. This will use the format name=value.
    
    Parameters:
    
    name - the name of value
    
    value - the value to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              long value)
```
    Appends the name-value pair. This will use the format name=value.
    
    Parameters:
    
    name - the name of value
    
    value - the value to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              float value)
```
    Appends the name-value pair. This will use the format name=value.
    
    Parameters:
    
    name - the name of value
    
    value - the value to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              double value)
```
    Appends the name-value pair. This will use the format name=value.
    
    Parameters:
    
    name - the name of value
    
    value - the value to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              char value)
```
    Appends the name-value pair. This will use the format name=value.
    
    Parameters:
    
    name - the name of value
    
    value - the value to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              boolean value)
```
    Appends the name-value pair. This will use the format name=value.
    
    Parameters:
    
    name - the name of value
    
    value - the value to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
    
    Since:
    
    1.5
  - append
```
public <K,V> ToStringBuilder append(String name,
                                    Map<K,V> map)
```
    Appends the name-map pair. This will use the format name=[key>value,key>value]. The key and value of map will use its respective Object.toString(), or "null" will be used if it is null.
    
    Type Parameters:
    
    K - the type of key
    
    V - the type of value
    
    Parameters:
    
    name - the name of map
    
    map - the Map to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
    
    Since:
    
    1.5
  - append
```
public ToStringBuilder append(String name,
                              Iterable<?> iterable)
```
    Appends the name-iterable pair. This will use the format name=[value,value]. The elements of iterable will use its Object.toString(), or "null" will be used if it is null.
    
    Parameters:
    
    name - the name of iterable
    
    iterable - the Iterable to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
    
    Since:
    
    1.5
  - append
```
public ToStringBuilder append(String name,
                              Object[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values or a value is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              byte[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              short[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              int[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              long[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              float[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              double[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              char[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
  - append
```
public ToStringBuilder append(String name,
                              boolean[] values)
```
    Appends the name-values pair. This will use the format name=[value,value]. Each value of values will use its Object.toString(), or "null" will be used if values is null.
    
    Parameters:
    
    name - the name of values
    
    values - the values to append
    
    Returns:
    
    this builder for chaining
    
    Throws:
    
    IllegalArgumentException - if name is null
    
    Since:
    
    1.5
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ToStringBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ToStringBuilder

Method Detail

forClassName

forClass

forObject

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

toString