com.frostphyr.avail

Class ToStringBuilder

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]]

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ToStringBuilder()

Method Summary

Modifier and Type	Method and Description
ToStringBuilder	append(String name, byte[] value) Appends the specified name-value pair.
ToStringBuilder	append(String name, char value) Appends the specified name-value pair.
ToStringBuilder	append(String name, char[] value) Appends the specified name-value pair.
ToStringBuilder	append(String name, Collection<?> value) Appends the specified name-value pair.
ToStringBuilder	append(String name, double value) Appends the specified name-value pair.
ToStringBuilder	append(String name, double[] value) Appends the specified name-value pair.
ToStringBuilder	append(String name, float value) Appends the specified name-value pair.
ToStringBuilder	append(String name, float[] value) Appends the specified name-value pair.
ToStringBuilder	append(String name, int value) Appends the specified name-value pair.
ToStringBuilder	append(String name, int[] value) Appends the specified name-value pair.
ToStringBuilder	append(String name, long value) Appends the specified name-value pair.
ToStringBuilder	append(String name, long[] value) Appends the specified name-value pair.
ToStringBuilder	append(String name, Object value) Appends the specified name-value pair.
ToStringBuilder	append(String name, Object[] value) Appends the specified name-value pair.
ToStringBuilder	append(String name, short[] value) Appends the specified name-value pair.
static ToStringBuilder	forClass(Class<?> clazz) Creates a new ToStringBuilder for the specified Class.
static ToStringBuilder	forClassName(String className) Creates a new ToStringBuilder for the specified className.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ToStringBuilder

public ToStringBuilder()

Method Detail

forClassName

public static ToStringBuilder forClassName(String className)

Creates a new ToStringBuilder for the specified className.

Parameters:

className - the name of the Class whose toString() is being built; cannot be null

forClass

public static ToStringBuilder forClass(Class<?> clazz)

Creates a new ToStringBuilder for the specified Class. This creates a ToStringBuilder from Class.getSimpleName().

Parameters:

clazz - the Class whose toString() is being built; cannot be null

append

public ToStringBuilder append(String name,
                              Object value)

Appends the specified name-value pair. The value's toString() method is used for the textual representation. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              int value)

Appends the specified name-value pair.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              long value)

Appends the specified name-value pair.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              float value)

Appends the specified name-value pair.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              double value)

Appends the specified name-value pair.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              char value)

Appends the specified name-value pair.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              Object[] value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              byte[] value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              short[] value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              int[] value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              long[] value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              float[] value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              double[] value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              char[] value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

append

public ToStringBuilder append(String name,
                              Collection<?> value)

Appends the specified name-value pair. If the value is null, "null" will be used.

Parameters:

name - the name of the value; cannot be null

value - the value to append

Returns:

this ToStringBuilder for chaining

toString

public String toString()

Overrides:

toString in class Object